- Read the https://github.com/kellyelton/OCTGN/blob/master/README.md -- IRC, Mailing List, Issues, etc.
- HELP US CODE:
- Create a github account (https://github.com/signup/free)
- Setup git locally (http://help.github.com/win-set-up-git/)
- Fork the repository (http://help.github.com/fork-a-repo/)
- Make your awesome change! (by following this file)
- Request we pull it in (http://help.github.com/send-pull-requests/)
- Install Chocolatey (http://chocolatey.org/)
- Install .Net 4.0 (http://www.microsoft.com/en-us/download/details.aspx?id=17718)
- Open a command prompt and type: cinst OctgnDevPackage-Express
- Fork & Clone (Links Under Get Involved! above)
- Open the main project file under OCTGN/OCTGN.sln with Visual Studio Express C#
- Do the greatness!
TODO: Installer, octgnFX/Graphics, octgnFX/Lib, octgnFX/Octgn.Data, octgnFX/Octgn.LobbyServer, octgnFX/Octgn.Server, octgnFX/Octgn.StandAloneServer, octgnFX/Skylabs.Lobby
Octgn uses IronPython for its in-game scripting engine.
The python definitions go in PythonApi.py. You can call outside code with the following syntax: _api.function_name and it will call the corresponding function in ScriptApi.cs. For example, the following code found in PythonApi.py is the random function:
return _api.Random(min, max)```
It calls Random with a min and max value that is located in [ScriptApi.cs](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/ScriptAPI.cs).
# octgnFX/Octgn.Data
Octgn.Data is the access to the database (mostly). OCTGN uses a SQLite Database to hold all game, set, and card data. This project provides access to that data in meaningful formats. Most of the items in this project are relatively self-explanatory, but keep in mind that many of them are only the data counterparts of octgnFX/Octgn classes.
Some of the classes do not (as of yet) have direct connections to the database. Deck.cs is a prime example. Currently all decks are stored/accessed as individual files with the user determining name and location.
Cards are installed through [Octgn.Data/Game.cs](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn.Data/Game.cs). Data is read from a Set Def, which is a zip file that contains XML card definitions, images, and relationship data. OCTGN parses the cards through a [CardModel.cs](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn.Data/CardModel.cs) constructor (passing along an XML reader), and Inserts the models individually into the database.