- Read the https://github.com/kellyelton/OCTGN/blob/master/README.md -- IRC, Mailing List, Issues, etc.
- HELP US CODE:
Your own awesome changes
- Get Visual Studio Express C# (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-csharp-express)
- Open the main project file under OCTGN/octgnFX/Octgn/OCTGN.sln with Visual Studio Express C#
- Do the greatness!
To work on the web component
Note: This project is not included in the main project, because having it included makes it unable to be opened from express editions, and we want to keep the development process open to all. It requires the main project to be built so it can include the required assemblies.
- Get Visual Web Developer Express (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-web-developer-express)
- Open the subproject file under Webcontent/Webcontent.csproj with the web developer version of Visual Studio Express
- Important This project references two components from the main project, you will have to add them as references
- Do the greatness!
TODO: Installer, octgnFX/CassiniDev, octgnFX/ConsoleHelper, octgnFX/Graphics, octgnFX/Lib, octgnFX/Octgn.Data, octgnFX/Octgn.LobbyServer, octgnFX/Octgn.Server, octgnFX/Octgn.StandAloneServer, octgnFX/Skylabs.Lobby, octgnFX/Skylabs.MultiLogin, octgnFX/Webcontent
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:
def rnd(min, max):
return _api.Random(min, max)
It calls Random with a min and max value that is located in ScriptApi.cs.
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. 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 constructor (passing along an XML reader), and Inserts the models individually into the database.