diff --git a/README.md b/README.md index bbc6972..98b69ce 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,66 @@ # OpenSim Engine -- Readme ## Overwiew: - -OpenSim Engine is intended to run OpenSim based simulators in ways it can be accessed and managed easily, and looks to be part of a more elaborated code in order to deploy and configure Sims or Grids automatically, in the Docker way. Commits are welcome! +OpenSim Engine is intended to run OpenSim based simulators +Although its main goal is to be part of a more elaborated solution to deploy simulators and/or grids, it can be used *as is* to test and even run (very simple) configurations inside containers. ## Features: +- Built upon the latest version of Mono (6.xx) +- Contains minimal tools to download and manipulate ZIP compressed binaries inside the container +- It runs OpenSim.exe onto a detachable console you can access the main screen, see status and use CLI. +- Allows both standalone sims/grids (e.g. OpenSim, DivaDistro), and also connect your sims to existing grids (e.g. OSGrid) -Runs standalone sims/grids, and allows to connect your sims to an existing grid -It can be connected to a database server if needed. +NOTE: The image does not provide the simulator files, you have to provide them yourself. -## Content: +## Requirements: +- Docker Engine. See [Docker Documentation](https://docs.docker.com/get-docker/) for further instructions +- Main simulator folder tree uncompressed, and accessible by Docker with write permissions -- The latest version of Mono -- Unzip, to unpackage many available simulators that come in ZIP format -- GNU Screen, in order to run OpenSim.exe on it, being able to attach / detach the console without close the program. +### Basic Usage +Useful for tests, and also for running very simple configurations (e.g. standalone and/or default SQLite setup): -## Basic Requirements: +`docker run -it --restart= --name -v :/opensim -p 9XXX[-9YYY]:9XXX[-9YYY]/tcp -p 9XXX[-9YYY]:9XXX[-9YYY]/udp adrianparilli/opensim-engine[: