mirror of
https://github.com/simon987/Much-Assembly-Required.git
synced 2025-04-18 02:06:43 +00:00
95 lines
3.1 KiB
Markdown
95 lines
3.1 KiB
Markdown
### [Official website](https://muchassemblyrequired.com)
|
|
Program the 8086-like microprocessor of a robot in a grid-based multiplayer world. The game is web based so no installation is required.
|
|
In its current state, players can walk around the game universe and collect Biomass blobs & Iron/copper ore using the online code editor.
|
|
|
|
|
|
|
|
Wiki: [GitHub](https://github.com/simon987/Much-Assembly-Required/wiki)
|
|
Chat: [Slack](https://join.slack.com/t/muchassemblyrequired/shared_invite/enQtMjY3Mjc1OTUwNjEwLTkyOTIwOTA5OGY4MDVlMGI4NzM5YzlhMWJiMGY1OWE2NjUxODQ1NWQ1YTcxMTA1NGZkYzNjYzMyM2E1ODdmNzg)
|
|
|
|
# Deploying the server
|
|
|
|
## Linux (Ubuntu 16.04)
|
|
```bash
|
|
# Install tools
|
|
sudo apt install git maven openjdk-8-jdk mongodb
|
|
|
|
# Obtain source files
|
|
git clone https://github.com/simon987/Much-Assembly-Required.git
|
|
|
|
# Build
|
|
cd Much-Assembly-Required
|
|
mvn package
|
|
|
|
# Run
|
|
cd target
|
|
java -jar server-1.4a.jar
|
|
```
|
|
|
|
## Windows (tested on Windows 10)
|
|
|
|
Installation instructions:
|
|
1. Download the JDK from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
|
|
Install the JDK and update your PATH and JAVA_HOME enviroment variables.
|
|
2. Download Maven from [here](https://maven.apache.org/).
|
|
Install Maven (following the README) and update your PATH enviroment variable.
|
|
3. Download Mongo DB Community from [here](https://www.mongodb.com/download-center#community).
|
|
Install Mongo DB following the instructions [here](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/).
|
|
Update your PATH enviroment variable.
|
|
|
|
Building instructions:
|
|
```batch
|
|
:: Builds the server
|
|
cd Much-Assembly-Required
|
|
mvn package
|
|
```
|
|
|
|
Running instructions:
|
|
1. In one Command Prompt window, run Mongo DB:
|
|
```batch
|
|
:: Runs Mongo DB
|
|
mongod
|
|
```
|
|
2. In a second Command Prompt window, run the MAR server:
|
|
```batch
|
|
:: Runs the MAR server
|
|
cd Much-Assembly-Required\target
|
|
java -jar server-1.4a.jar
|
|
```
|
|
|
|
## Docker
|
|
### Requirements
|
|
|
|
1. [Docker Compose](https://docs.docker.com/compose/install/#install-compose) (and dependencies)
|
|
|
|
### Installation
|
|
|
|
Once Docker and Docker Compose are installed, you can build and start
|
|
this application by running the following command inside this
|
|
application's directory:
|
|
|
|
`docker-compose up`
|
|
|
|
Make sure to change `mongo_address` in `config.properties` to `mongodb`.
|
|
|
|
|
|
## Vagrant
|
|
### Requirements
|
|
1. [Vagrant](https://www.vagrantup.com/downloads.html)
|
|
2. [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
|
|
|
|
### Installation
|
|
|
|
When vagrant is installed, you can build and start this application by running the following
|
|
command inside this application's directory:
|
|
|
|
`vagrant up`
|
|
|
|
# Running
|
|
|
|
Once the server is running, you should be able to connect to `http://localhost:4567` with your browser
|
|
|
|
## VS Code Extensions
|
|
- [Much Assembly Required (Upload on Save)](https://marketplace.visualstudio.com/items?itemName=tomhodder.much-assembly-required-upload-on-save) by tomhodder
|
|
- [Much Assembly Required Language Support](https://marketplace.visualstudio.com/items?itemName=PJB3005.much-assembly-required-language-support) by PJB3005
|