Skip to content

Commit

Permalink
chore: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
phinner committed Apr 18, 2024
1 parent 7663bd8 commit f98f371
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

The core of the Chaotic server network, maintained by Xpdustry.

## Contributing

We welcome contributions from developers of all levels of experience, including beginners who are eager to learn.
If you're interested in contributing to Imperium, feel free to explore our codebase,
check the issue tracker for tasks or bugs, and don't hesitate to ask questions on our Discord server.

## Building

You will need:
Expand All @@ -27,7 +21,7 @@ Imperium needs a mariadb database and a rabbitmq server in order to function.
Fortunately for you, a docker-compose file is provided with everything.
You will simply have to run `docker-compose up -d` once.

> RabbitMQ has a web front-end at http://localhost:15672, you can login with guest:guest.
> RabbitMQ has a web front-end at http://localhost:15672, you can log in with guest:guest.
### Mindustry

Expand All @@ -36,6 +30,7 @@ with the following content:
```yaml
server:
name: "name of the server (must be alphanumeric)"
gamemode: SURVIVAL
```
Then for starting a local mindustry server, run `./gradlew imperium-mindustry:runMindustryServer`.
Expand Down Expand Up @@ -69,6 +64,10 @@ Then you can start the discord bot by running `./gradlew imperium-discord:runImp
> If it's the first time you run it, it will automatically download mindustry assets from GitHub,
> this might take less than a minute. (Or more if you have potato internet `;-;`)

## Limitations
## Support

This plugin is open source for transparency and also easing contributions from CN players.
You are free to ask any question about the internals of this project in the issues tab or on discord.

- This plugin is not designed to run as a steam server. It will crash if you try.
**BUT**, do not expect any support if you are trying to use this project as it is in your own infrastructure.
This project is written with the xpdustry infrastructure and features in mind after all.

0 comments on commit f98f371

Please sign in to comment.