Skip to content
Flux Community Edition (CE); A free and open-source Garry's Mod gamemode framework.
Lua Other
  1. Lua 99.8%
  2. Other 0.2%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config make linter happy May 16, 2019
crates [UI] Plugin descriptions display added Aug 7, 2019
docs
gamemode
lib
plugins Merge branch 'master' of https://github.com/TeslaCloud/flux-ce Aug 7, 2019
.gitignore rearrange file structure May 1, 2019
LICENSE
credits.txt update credits May 16, 2019
flux.cratespec bump version Jul 6, 2019
flux.txt bump version Jul 6, 2019
readme.md
thirdparty_copyright.md typo Mar 8, 2019

readme.md

Flux

Flux is a WIP gamemode framework designed with performance and convenience in mind.

Alpha release

Current version of Flux is currently in active development as an open alpha. This means that you can install it and it will run, but there will almost inevitably be bugs and issues, as well as a lot of missing features. If you are not a developer, it is probably better for you to wait until Flux is in beta.

Installation

If you want to just get Flux up and running, simply download this repo, as well as the reborn schema, and match the repo folders with your Garry's Mod dedicated server folders. You can also clone this repo directly and then install the server on top, so that you get an easy way to update without hassle.

Flux is only guaranteed to work on dedicated servers (srcds). We do not support "listen" servers (launching from Garry's Mod client).

Database setup

Depending on your use case, you may want to setup a database. An SQLite is the default option and requires no further setup. It is perfect if you simply want to take a look at Flux and how it works. If you want to run Flux in production, however, you should consider setting up a MySQL (MariaDB) or PostgreSQL database.

Follow the instructions in /garrysmod/gamemodes/flux/config/database.yml to learn more.

Environment

By default, Flux comes with production environment pre-chosen. It is good if you don't want to write code. If you plan on writing plugins, schemas or modifying the framework, you should set your environment to development. No other environments are supported yet! If you wish to change your environment, copy the gamemodes/flux/config/environment.lua file as environment.local.lua and change production to development inside that file.

What is the difference between production and development?

In production, code runs a little bit faster, but it sacrifices error-tolerance and refreshability. It it perfect when you are running your server properly, because in that case you don't want to refresh the code anyway (since it causes a lot of lag).

In development, code runs slower, but is a lot more tolerant to errors. It uses safe mode on hooks and print lots of useful debug information, such as load order. Due to the speed sacrifice, it is only practical to run development when actually developing.

Upgrading

During Alpha, the database may break between versions. This will be different in beta and beyond, but until then, if you are upgrading Flux you need to recreate the database manually every time.

To do that, simply follow the steps below:

  1. Delete the /garrysmod/gamemodes/**your_schema**/db/ folder.
  2. Follow the database-specific instructions below:

SQLite

  1. Simply delete the /garrysmod/sv.db file.
  2. Restart the server.

MariaDB (MySQL)

  1. Open the MySQL console (mysql command on Linux) or any other means of managing your database.
  2. Drop the table specified in /garrysmod/gamemodes/flux/config/database[.local].yml. To do that from console, simply run DROP DATABASE database_name_here;, replace database_name_here with your database name.
  3. Create a new database. To do that, run CREATE DATABASE database_name_here;, replace database_name_here with your database name.
  4. Restart the server.

PostgreSQL

  1. Open psql or pgAdmin (sudo -u postgres psql).
  2. Drop the table specified in /garrysmod/gamemodes/flux/config/database[.local].yml. To do that from psql, simply run DROP DATABASE database_name_here;, replace database_name_here with your database name.
  3. Create a new database. To do that, run CREATE DATABASE database_name_here;, replace database_name_here with your database name.
  4. Restart the server.

Playing

If you wish to play the gamemode, you should install the content addon to prevent purple-black checkers where the materials should be. You can find it here: https://steamcommunity.com/sharedfiles/filedetails/?id=1518849094

Other info

For more info or technical support, please visit our forums: http://f.teslacloud.net/

You can’t perform that action at this time.