Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.73 KB

README.md

File metadata and controls

61 lines (44 loc) · 3.73 KB

Card Fighters' Clash plugin for OCTGN

Card Fighters' Clash is a card game for two players based on SNK Playmore’s video game SNK vs. Capcom Card Fighters' Clash 2 Expand Edition. Players try to defeat each other playing powerful characters from video games licensed by Capcom and SNK Playmore.

This repository contains a game definition plugin for the free card game engine Online Card and Tabletop Gaming Network (OCTGN). This plugin allows online playing and creation of CFC decks.

Official plugin site: https://cardfightersclash.wordpress.com/

Development

The project uses Rake to automate some tasks, available through the following commands:

Command Description
rake build Builds a .o8g and a .nupkg file from the game definition files using o8build.exe.
rake deploy Builds and moves the NUPKG file to the OCTGN LocalFeed directory.
rake copy Copies python files to the game's script folder under OCTGN's games database folder. Useful when debugging your game along with the built-in functionality to reload python scripts.
rake test Verifies the files as a valid game definition.
rake versionbump Increases the build number by 1 in the definition.xml file.
rake octgn Runs OCTGN in development mode, in the table view with the CFC plugin loaded.
rake docs Converts Markdown documents in Documents/ folder into HTML files.

Use bundler to install the dependencies listed in the Gemfile.

Card Templates

CFC card templates (and sets of cards) are created and managed using Magic Set Editor 2 software and a custom template.
The card template is exported as an OCTGN proxy card, hence the image packs for the cards only contains the illustrations.

Card Coding

The game play is totally automated using OCTGN Python API, which means that players don't need to do any manual action to move the game forward. You can play CFC the same way you play Magic: The Gathering Arena or Hearthstone in your computer.

The mechanics of each card (this is, the rules of the card that interact with the game) are coded in RuleScript. You can find the documentation here.

Developing for OCTGN

OCTGN Game Development wiki: https://github.com/octgn/OCTGN/wiki#create-games-on-octgn

Command Line Arguments

Run OCTGN.exe [OPTION], where...

Option Description
/t
/table
Starts OCTGN in the table view
/g="game GUID"
/game="game GUID"
Starts with selected game
/d="path/to/deck"
/deck="path/to/deck"
Loads a deck
/x
/devmode
Enables dev mode with the scripting console enabled

Debug

OCTGN Game logs are stored as .o8l files under the folder Documents/OCTGN/History/.

Tips and Donations

If you find this OCTGN plugin useful, you can consider making a tip to support this project. Every little bit helps.

ko-fi

License

Released under the GNU General Public License version 3.


This project neither the author(s) are not affiliated with SNK Playmore or Capcom. All trademarks, trade names, services marks and logos belong to their respective companies.