Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specification #1

Open
The-Noah opened this issue Jan 15, 2021 · 0 comments
Open

Specification #1

The-Noah opened this issue Jan 15, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@The-Noah
Copy link
Member

The-Noah commented Jan 15, 2021

⚠ 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)
@The-Noah The-Noah added the documentation Improvements or additions to documentation label Jan 15, 2021
@The-Noah The-Noah self-assigned this Jan 15, 2021
@The-Noah The-Noah added this to the v1.0 milestone Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant