Skip to content
Permalink
Browse files

Update README & HACK

cleaned up old/dead links, added Discord, HACK needs more
  • Loading branch information...
BenMatteson committed Oct 29, 2017
1 parent fd31d05 commit 873c5762c96319f3db03130f769c517f5d372c95
Showing with 30 additions and 56 deletions.
  1. +17 −36 HACK.md
  2. +13 −20 README.md
53 HACK.md
@@ -1,35 +1,16 @@
Get Involved!
Contribute!
-------------------------------------------------
* Read the https://github.com/kellyelton/OCTGN/blob/master/README.md -- IRC, Mailing List, Issues, etc.
* To get started, Join us on <a href="https://discord.gg/Yn3Jrpj">Discord</a>
* Sign the Contributor License Agreement https://www.clahub.com/agreements/octgn/OCTGN
* *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/)

Your own awesome changes(This is a bit out of date but should still work)
-------------------------------------------------
* Install Chocolatey (http://chocolatey.org/)
* Install .Net 4.0 (http://www.microsoft.com/en-us/download/details.aspx?id=17718)
* Install Awesomium 1.7.4.2 (http://www.awesomium.com/downloads/awesomium_1_7_4_2_sdk_win.exe)
* 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!

Recommended GitConfig Settings
-------------------------------------------------
```
[core]
repositoryformatversion = 0
filemode = false
ignorecase = true
autocrlf = false
[push]
default = simple
```
* Setup git locally (https://help.github.com/win-set-up-git/)
* Fork the repository (https://help.github.com/fork-a-repo/)
* Install the latest version of Visual Studio https://www.visualstudio.com/vs/
* Make your awesome change!
* Request we pull it in (https://help.github.com/send-pull-requests/)


Components
-------------------------------------------------
**TODO:** Installer, octgnFX/Graphics, octgnFX/Lib, octgnFX/Octgn.Data, octgnFX/Octgn.LobbyServer,
@@ -38,16 +19,16 @@ octgnFX/Octgn.Server, octgnFX/Octgn.StandAloneServer, octgnFX/Skylabs.Lobby
# Python
Octgn uses IronPython for its in-game scripting engine.

The python definitions go in [PythonApi.py](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/PythonAPI.py). You can call outside code with the following syntax: _api.function_name and it will call the corresponding function in [ScriptApi.cs](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/ScriptAPI.cs).
For example, the following code found in [PythonApi.py](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/PythonAPI.py) is the random function:
```def rnd(min, max):
return _api.Random(min, max)```
The python definitions go in [PythonApi.py](https://github.com/octgn/OCTGN/blob/master/octgnFX/Octgn/Scripting/PythonAPI.py). You can call outside code with the following syntax: _api.function_name and it will call the corresponding function in [ScriptApi.cs](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/ScriptAPI.cs).
For example, the following code found in [PythonApi.py](https://github.com/octgn/OCTGN/blob/master/octgnFX/Octgn/Scripting/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](https://github.com/kellyelton/OCTGN/blob/master/octgnFX/Octgn/Scripting/ScriptAPI.cs).
It calls Random with a min and max value that is located in [ScriptApi.cs](https://github.com/octgn/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.
Octgn.Data is the access to the database (mostly). 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.
@@ -1,25 +1,18 @@
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/kellyelton/octgn/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

To get started, <a href="https://www.clahub.com/agreements/octgn/OCTGN">sign the Contributor License Agreement</a>.
OCTGN 3.0
Welcome to the OCTGN open source project.
=================================================
This is the new home for the OCTGN open source project.

* Need general help?
* Check out the forum -> http://www.octgn.net/help
* Join our open IRC chat: irc.freenode.net | #octgn
* Web Client -> http://webchat.freenode.net/?channels=octgn
* IRC client -> irc://irc.freenode.net/#octgn
* Want to help with the project(for devs, or those interested in developing only)? Join our developers chat on IRC: irc.freenode.net | #octgn-dev
* Web Client -> http://webchat.freenode.net/?channels=octgn-dev
* IRC client -> irc://irc.freenode.net/#octgn-dev
* Mailing List: http://groups.google.com/group/octgn-dev
* Bugs? Want features? https://github.com/kellyelton/OCTGN/issues
* License: https://github.com/kellyelton/OCTGN/blob/master/LICENSE.md
* Get Coding: https://github.com/kellyelton/OCTGN/blob/master/HACK.md
Download Site: http://www.octgn.net/
-------------------------------------------------

Get Involved
-------------------------------------------------
* Join our Discord server! -> https://discord.gg/Yn3Jrpj

Want to contribute?
* Check out https://github.com/octgn/OCTGN/blob/master/HACK.md


Useful Links
=================================================
These are just related links.

* Download Site: http://www.octgn.net/
* Bugs? Want features? https://github.com/octgn/OCTGN/issues
* License: https://github.com/octgn/OCTGN/blob/master/LICENSE.md

0 comments on commit 873c576

Please sign in to comment.
You can’t perform that action at this time.