Warning

THIS DOCUMENTATION IS IMCOMPLETE!

Getting Started - SUFFERING Mod API

CURRENTLY WORK IN PROGRESS!

Getting Started - SUFFERING Server Software

CURRENTLY IN DEVELOPMENT COMING SOON!

Getting Started

What is dotenv.lua

dotenv.lua is a minimal dotenv library for Lua 5.1+

SOURCE CODE: Here

From LDE

1. Run

lde add dotenv

2. Require it

require("dotenv")

From source

1. Clone the repository

git clone https://github.com/SyrupStudio/dotenv.lua/

2. Open the folder of the newly cloned repo

3. Drop dotenv.lua into your project and require it

require("dotenv")

How it works (lazy edition)

Basic Usage

local dotenv = require("dotenv")

local ok, err = dotenv.load()
if not ok then
    error(err)
end

-- if you are lazy you can just do
-- dotenv.load()

dotenv.check()

local apiKey = dotenv.get("API_KEY")
local port = dotenv.get("PORT", "8080") -- fallback to 8080

.env File Format

# comments are ignored ofc
API_KEY=abc123
PORT=8080

Limitations

INLINE COMMENTS ARE NOT SUPPORTED Why you may ask? Becuase the parser treats everything after the = as the value

# comments are ignored ofc
API_KEY=abc123
PORT=8080 # DO NOT DO THIS

Ofc unless you want a lovely error like this

attempt to perform arithmetic on local 'b' (a string value)

Actinium

What is Actinium

Actinium is a game engine designed and developed by Actinium Studios for our needs but it is open source and available for anyone to use!

Caution

Actinium is currently in development and not ready for production use!

Comparison with other game engines

Note

⭐ = especially strong, ✅ = supported, ⚠️ = limited support, ❌ = not supported