Separation of concerns for docker files and building (#41)

* Separation of concerns for docker files and building

* Separated out readme context
This commit is contained in:
Michael
2021-02-10 18:06:42 -07:00
committed by GitHub
parent 60d77d22c6
commit cb31cd0675
11 changed files with 240 additions and 212 deletions

View File

@@ -47,52 +47,11 @@ services:
- ./valheim/server:/home/steam/valheim
```
## Odin
Odin is a CLI tool utilized for installing, starting, and stopping [Valheim] servers
### Gotchas
### [Odin]
- Odin relies on Rust. [Please install Rust](https://www.rust-lang.org/tools/install)
- Odin also assumes that you have SteamCMD already installed. [Install instructions for SteamCMD.](https://developer.valvesoftware.com/wiki/SteamCMD)
- If you have the proper build tools installed you should be able to run Odin on any system.
- Current Supported Architecture: Unix & Linux based systems.
### Installation
> Make sure you have build essentials installed before you install this crate
```sh
cargo install --git https://github.com/mbround18/valheim-docker.git --branch main
```
### Usage
![Main Menu](./docs/assets/main-menu.png)
#### Install Valheim
```sh
odin install
```
![Install Menu](./docs/assets/install-menu.png)
#### Start Valheim
```sh
odin start
```
![Start Menu](./docs/assets/start-menu.png)
#### Stop Valheim
```sh
odin stop
```
![Install Menu](./docs/assets/stop-menu.png)
This repo has a CLI tool called [Odin] in it! It is used for managing the server inside the container. If you are looking for instructions for it click here: [Odin]
## Versions:
@@ -128,6 +87,7 @@ odin stop
[//]: <> (Links below...................)
[Odin]: ./docs/odin.md
[Valheim]: https://www.valheimgame.com/
[//]: <> (Image Base Url: https://github.com/mbround18/valheim-docker/blob/main/docs/assets/name.png?raw=true)