Skip to content

Specification #1

@The-Noah

Description

@The-Noah

⚠ This is WIP

Why?

bsm works because files/directories have a specific structure. This should be documented and finalized.

Structure

  • / refers to the directory where all related files are stored, such as /home/bzfs/myserver.
  • server refers to a bzfs instance.
  • map refers to the configuration used to run a server (bzw+config).
  • world refers to the bzw file.
  • Paths ending in / refer to a directory.
Path Description
/log.sh Bash script that takes in the output from bzfs - this should be part of bsm and not it's own script
/configs/master.conf Configuration file loaded for every server
/configs/publickey Contains the public key to be used (optional)
/configs/groups.txt Group permissions file (optional)
/configs/badwords.txt Badwords file (optional)
/maps/ Stores one map per subdirectory, with the subdirectory name being the ID
/maps/name/config.conf Map-specific configuration file
/maps/name/map.bzw Map world file
/maps/name/pid PID of the running server (auto generated)
/maps/name/reports.txt Reports for the map (auto generated)
/maps/name/logs/ Log files by date (auto generated)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions