Deployment Documentation

Custom Wars Tactics can run on any system that supports Eclipse, Git and Maven.

---

Folder Setup

Caution error: cannot find symbol

Related issues #61 and #56

---

CustomWars:Tactics game engine

This section decribes how you can build the game engine from source.

Requirements

• Eclipse 4.4.1
• Git
• Maven (Should be included in Eclipse)

Setup the development environment

1. Download and install Eclipse 4.4.1
2. Make sure that Maven Integration for Eclipse is installed from the Eclipse Marketplace
3. Checkout the web page source from our github repository and select the master branch
4. Import the folder as java project
5. Convert the project to a maven project by selecting the following in the context menu Configure => Convert to maven project
6. Create a new Maven build starter in the Run => Run Configurations.. dialog with the name BUILD GAME ENGINE JS

• Set the working directory to the folder of the web page project
• Add compile org.st-js:maven-plugin:generate as maven goal
• EMBEDDED 3.x.y.z should be selected as maven runtime

Build the game

..Under construction..

Running the game

..Under construction..

---

CustomWars:Tactics web page

This section describes how you can build the web page from source.

Requirements

• Eclipse 4.4.1
• Git
• Maven (Should be included in Eclipse)

Setup the development environment

1. Download and install Eclipse 4.4.1
2. Make sure that Maven Integration for Eclipse is installed from the Eclipse Marketplace
3. Checkout the web page source from our github repository and select the gh-pages branch
4. Import the folder as java project
5. Convert the project to a maven project by selecting the following in the context menu: Configure => Convert to maven project
6. Create a new Maven build starter in the Run => Run Configurations.. dialog with the name BUILD WEBPAGE JS

• Set the working directory to the folder of the web page project
• Add compile org.st-js:maven-plugin:generate org.apache.maven.plugins:maven-antrun-plugin:run as maven goal
• EMBEDDED 3.x.y.z should be selected as maven runtime

Build the web page

1. Run the BUILD WEBPAGE JS starter to generate the javascript file (There should be a BUILD SUCCESS in your console when the build was successful)
2. Start a http server which uses your project folder as document root
3. Open localhost/index.html in your web browser

Publish the web page

1. Check the web page by doing everything in Build the web page
2. Commit your changes
3. Publish your committed stuff to the repository

The changes should be visible on ctomni231.github.io/cwtactics in some minutes.

---

Deprecated Information

The game files will be generated with the build system grunt. To download all dependencies manually you simply have to write npm install in your terminal while being in the root directory of the Custom Wars: Tactics repository. After that you can invoke the build process by typing the command grunt in your console.

grunt <Command>

Commands:

 docs   = Generates the documentation of CustomWars:Tactics
 report = Generates a mnarkdown file with all todo marks
 live   = Builds the game and it's dependencies in live mode (uglified)
 dev    = Builds the game and it's dependencies in debug mode
 
 default is dev