Skip to content

Manage your multi-tournament LAN without opening Excel

Notifications You must be signed in to change notification settings

Oozturn/oozturn

Repository files navigation

Logo

Manage your multi-tournament LAN without opening Excel

AGPL License

Features

⚙️ Complete LAN configuration from app interface ⚔️ Duels and FFA tournaments 🏆 Global tournament, with cutomizable points for each tournament 👤 Players management 🎯 Achievements 🏅 Leaderboard for both players and teams

Getting Started

This app can be used either using Docker or manually.

Settings:

OOZTURN accepts the following settings, to set with environment variables:

Environment variables Usage Default value
ADMIN_PASSWORD Admin password. This parameter is mandatory to enable the admin panel. Without it, admin pages can't be accessed. empty
ALL_OPPONENTS_SCORE Allow all opponents to score. can be "false", "duel_only", "true". false
ASK_FOR_SEATS Asks users to enter their seat. true
DISABLE_TOURNAMENT_NOTIFICATIONS Disable notifications when tournaments gets an update false
UNSAFE_ALLOW_REGISTER_BY_NEW_USERS Allow any new user to register himself.
By default only admins can register new users. This is ignored for the first account to be created, able to register itself.
false
UNSAFE_NO_AUTHENTICATION Disable user passwords. A password is still needed for the admin page. false
UNSAFE_DISABLE_STRONG_PASSWORDS By default, passwords must be of at least 8 character and contain:
- a lowercase
- an uppercase
- a number
- a special character
This option allows dump passwords.
false
UNSAFE_ALLOW_EASY_LOGIN Allow to list users on login page false
UNSAFE_USE_HTTP_ONLY Allow to use HTTP environment (useful for LANs for exemple) false
LOG_LEVEL Change log level in the terminal. Can be "trace", "debug", "info", "warn", "error", "fatal". Trace level will allways be used for log files. "info"

By default, all unsafe options are disabled. For a LAN event, with known users, some options may be useful for QoL.

Docker

You can run the following command to start your OOZTURN instance:

Docker run -p <PORT>:3000 -e ADMIN_PASSWORD=<PASSWORD> bug38/oozturn

If you want to access your DB from the host, or reuse an existing one, you can mount /app/db.

To access uploads (users avatars, tournament images, lan Map) you can mount /app/uploads.

A docker-compose file is also available, showing the default settings.

Manually

This app requires the LTS version of NodeJS. Then:

  • Clone this repository and cd into it
  • Install dependencies with npm install
  • create a .env file and fill it with the required settings from above.
  • To run the server in dev mode run npm run dev
  • To run the server in production mode, build the application with npm run build then start the server with npm run start.
  • Open http://localhost:3000 with your browser to see the app
  • To access Admin panel after login, visit http://localhost:3000/admin

Demo

Here is a Demo. This demo uses the Lan'Oween 2024 database.

Used By

V1 was used for the Lan'Oween 2023 event, organized by the Azerty team.

V2 was used for the Lan'Oween 2024 event.

Credits

This app uses a derivative of the tournament-js module written by clux (Eirik A)

License

AGPL3

About

Manage your multi-tournament LAN without opening Excel

Resources

Stars

Watchers

Forks

Contributors

Languages