Skip to content

Commit

Permalink
Description about section added
Browse files Browse the repository at this point in the history
  • Loading branch information
barni10102 committed May 19, 2024
1 parent 0a37632 commit c364e4a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/deploment_with_vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,8 @@ To start:
2. Run `vagrant up` (wait for the boot process to complete, may take 5-10 minutes).
3. Start an SSH session to the VM from the directory of the Vagrantfile: `vagrant ssh -- -X` (in PuTTY, enable X11 forwarding in by going to Connection -> SSH -> X11 and checking "Enable X11 forwarding").
4. If prompted, log in (username: vagrant, password: vagrant).
5. The game will start by default. If the X11 server is not running on your machine, start it and then run `bash /home/vagrant/check-and-start-java.sh` to start the game.
5. The game will start by default. If the X11 server is not running on your machine, start it and then run `bash /home/vagrant/check-and-start-java.sh` to start the game.

About: Setting up a Vagrant virtual machine for this project offers several benefits. Firstly, it allows for easy testing of the program in a Linux environment, ensuring compatibility across different operating systems. Additionally, the VM setup eliminates the need to install Java on the host machine, simplifying the process of playing the game without any additional dependencies. Furthermore, Vagrant enables testing the program with a specific JDK version (openjdk 11, with the current setup) required to play the game, even if the host machine doesn't have the correct version installed. With Vagrant, the setup process only takes a few minutes and the VM setup can be done with a few simple commands.

![How the game looks in linux](vagrant.png)
Binary file added doc/images/vagrant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/vagrant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c364e4a

Please sign in to comment.