Giter Club home page Giter Club logo

kcdocker's Introduction


Knockout City Server - Docker

An Unofficial Docker Image that allows running a Private Server of Knockout City.

Report Bug

Table of Contents
  1. Prequisite
  2. Usage
  3. Contributing
  4. License

Prequisite

Usage

Copy the compose.yaml and tweak to your liking.

Then you can start the server as follows:

docker compose up

Environment Variables

For detailed information on the different parameters please refer to the Knockout City Private Server README.

Name Required Description
KOC_FORCE_SERVER_DONWLOAD No Forces to redownload the Server files.
default: false
KOC_SERVER_DONWLOAD_URL No The URL where the Knockout City Server files are located. If not specified will not redownload files. Must be specified for initialisation.

example: https://chonky-delivery-network.akamaized.net/KnockoutCity-Server-10.0-269701.zip
KOC_BACKEND_MAX_PLAYER_CONNECTIONS No The maximum number of players that can be connected at the same time.
default: 10
KOC_BACKEND_PORT No TCP port on which the online backend services listen.
default: 23600
KOC_SERVER_MIN_PORT No Start of UDP port range on which game servers will listen.
default: 23600
KOC_SERVER_MAX_PORT No End of UDP port range on which game servers will listen.
default: 23699
KOC_SECRET No A password that if specified needs also be passed to the KnockoutCity.exe
KOC_BACKEND_DB Yes PostgreSQL connection string to use a running PostgreSQL server.
KOC_BACKEND_REDIS_DB_HOST Yes Hostname of a running Redis Server.
KOC_BACKEND_REDIS_DB_PORT No Port of a running Redis Server.
default: 6379

(back to top)

Mods

In order to add mods to the server you can mount the /mod-loader directory to your local file system. Mods can be installed in there as well as configured.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

kcdocker's People

Contributors

tandashi avatar alexmkramer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.