This is the root of your AI. Stay out of the joueur/ folder, it does most of the heavy lifting to play on our game servers. Your AI, and the game objects it manipulates are all in games/game_name/, with your very own AI living in games/game_name/AI.java for you to make smarter.
This client has been tested and confirmed to work on the Campus rc##xcs213 Linux machines, but it can work on your own Windows/Linux/Mac machines if you desire.
make
./testRun MyOwnGameSession
JRE8 and Maven 3 are the only required packages, and can be found in openjdk-8-jdk-headless or java-common and maven packages respectively.
In addition, after you make once, you can do make core instead to just rebuild, and not fetch the dependencies again.
Just like in Linux, we can build this via the command line. Before you do so ensure that the JDK 8 and Maven are installed and accessible from the PATH (Maven will require setting your JAVA_HOME environmental variable). If you can run java, javac, and mvn via the command line in Windows you should be good.
Once those are installed run Maven to grab the packages you need:
mvn clean compile assembly:single
After you've done this step you theoretically never need to run it again, unless you wish to use more packages.
Now to compile the code, run:
win-compile.bat
This is simple batch file we've setup for you that runs javac with the arguments you need to compile.
If a compiler error happens it will be printed to the screen, but all other build printing has been silenced.
To run the client simply run our other batch script:
win-run.bat -s <server>
where <server> is the game server to connect to, any other args can be found via the -h help flag.
Another option is to use Eclipse and just create a new project from existing code, pointing to this repo. It should read the .classfile and .project file to setup the rest. Note you'll need the Maven plugin too.
Install Vagrant and Virtualbox in order to use the Vagrant configuration we provide which satisfies all build dependencies inside of a virtual machine. This will allow for development with your favorite IDE or editor on your host machine while being able to run the client inside the virtual machine. Vagrant will automatically sync the changes you make into the virtual machine that it creates. In order to use vagrant after installing the aforementioned requirements simply run from the root of this client:
vagrant upand after the build has completed you can ssh into the virtual environment by running:
vagrant sshFrom there you will be in a Linux environment that has all the dependencies you'll need to build and run this client.
When the competition is over, or the virtual environment becomes corrupted in some way, simply execute vagrant destroy to delete the virtual machine and its contents.
For a more in depth guide on using vagrant, take a look at their guide
Using Vagrant with Windows can be a bit of a pain. Here are some tips:
- Use an OpenSSH compatible ssh client. We recommend Git Bash to serve double duty as your git client and ssh client
- Launch the terminal of your choice (like Git Bash) as an Administrator to ensure the symbolic links can be created when spinning up your Vagrant virtual machine
It is possible that on your Missouri S&T S-Drive this client will not run properly. This is not a fault with the client, but rather the school's S-Drive implementation changing some file permissions during run time. We cannot control this. Instead, we recommend cloning your repo outside the S-Drive and use an SCP program like WinSCP to edit the files in Windows using whatever IDE you want if you want to code in Windows, but compile in Linux.
The only file you should ever modify to create your AI is the AI.java file. All the other files are needed for the game to work. In addition, you should never be creating your own instances of the Game's classes, nor should you ever try to modify their variables. Instead, treat the Game and its members as a read only structure that represents the game state on the game server. You interact with it by calling the game functions.