README.md (2881B)
1 # The Registrar's Repository 2 3 ## Instructions for a new Registrar 4 5 - Get familiarized with this repository (a description of the structure can be found later in this document). 6 7 - Install dependencies: 8 - Lua 5.4, as it is required to run the `registrar` script. 9 - jq 10 - m4 11 12 - Ensure you are able to read Message IDs for emails in your client. 13 14 - Setup weekly reminder for weekly report in whatever organizational 15 system you use. Any date is fine, but the deadline is always the end of 16 UTC sunday of that week. 17 18 - Upon reminder, perform the relevant checklist. 19 20 - Setup monthly reminder for monthly report in whatever organizational 21 system you use. Any date is fine, but the deadline is always the end of 22 the last day of that month. 23 24 - Upon reminder, perform the relevant checklist. 25 26 - Setup yearly reminders for announcing the birthdays of every active 27 player. 28 29 - Upon reminder, perform the relevant checklist. 30 31 - Continuously monitor the public fora for the following events: 32 33 - Registration 34 - Messages where a person declares their intent to register (R869) 35 - Cantus Cygnei 36 - Messages clearly labeled as a Cantus Cygneus (R1789) 37 - Deregistration 38 - Messages where a player voluntarily deregisters (R869) 39 - Messages where an inactive player is deregistered without 3 objections (R2646) 40 - Messages where a player is banned (R2679) 41 - Messages where a player is exiled (R2556) 42 - Deactivation 43 - Messages where a player is deactivated (R2646) 44 - Reactivation 45 - Messages where a player reactivates emself (R2646) 46 - CoEs 47 - Messages containing claims of error on the Registrar's reports. (R2201) 48 - Changes 49 - Messages in which pertinent rules are changed. 50 51 In case of any of these events, perform the relevant checklist. 52 53 - Optinally, setup some way to keep track of player activity, for the 54 purposes of inactivating them. If you find a good procedure, update 55 this documentation and create the relevant checklists. For now, I 56 (juan) am leaving this to other players. 57 58 - After any modification, you may run `./registrar check` to check the 59 integrity of this repository. This is not comprehensive, but it's an aid. 60 61 ## Repository structure 62 63 - `BACKLOG.md`. Notes on things to do to improve this repository and related things. 64 - `README.md`. This file. 65 - `archive`. Archive of old files; mainly reports. 66 - `checklists`. Checklists for various Registrar routines. 67 - `cantus`. Cantus Cygneus (not complete). 68 - `fora.json`. Data regarding fora, used by scripts. 69 - `lib`. Scripts that are called directly or indirectly by the main `registrar` script. 70 - `log.json`. Record of events. 71 - `players.json`. Current state of the game, as it relates to the Registrar's duties. 72 - `registrar`. The main Lua script for performing registrar actions. 73 - `templates`. Templates used for generating reports and other messages. 74 75