Files
Holocore/README.md
T
Ziggy 4a51b7396b Created a docker-compose.yml, which initializes and runs a mongo instance
The idea is to simplify the setup process a bit, so it's easier to get
to the point where you can develop.
2022-11-29 16:30:18 +01:00

1.7 KiB

Banner

License Discord

Introduction

This is a Star Wars Galaxies server emulator, targeted at the Combat Upgrade (CU) era of the game.

Vision

  • Providing an experience that's reasonably close to the original, out of the box
  • Easily expandable with new functionality
  • Good amount of configuration options for in-game features
  • Efficient use of system resources and solid performance

Setting up a development environment

Ready to help bring back an awesome MMORPG with your programming skills?

Java Development Kit

In order to compile the source code, you need a JDK installation on your machine. The JAVA_HOME environment variable should point to the directory of the JDK! It should be version 18 as minimum. You can see your installed Java version by running java -version.

Submodules

The project uses submodules. Get them by running: git submodule update --init

MongoDB

A MongoDB instance can be bootstrapped by running docker-compose up -d.

This will run and initialize a MongoDB instance with a default game server user.

  • Username: user
  • Password: pass

This will also run a web UI, which can be accessed in the browser at: http://localhost:8081

You can stop both with: docker-compose down.

Running Holocore

Compile and run Holocores main code using Gradle: ./gradlew runDevelopment

Running automated tests

Compile and run Holocores automated tests using Gradle: ./gradlew test --info

Running your own server

If you're interested in running your own server, you should use the provided Docker image.