imcompiling/dakiny-messages
1
0
Fork 0
Code Pull Requests Activity

Fill out readme with list of template placeholders and some information on tagging/formatting.

Browse Source
This commit is contained in:
imcompiling
2024-05-24 14:52:53 -04:00
parent f9312dac3f
commit 4e99279411
1 changed files with 52 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+52 -3
View File
@@ -5,13 +5,62 @@ It is important that all directories inside "messages" match the channel name yo
I will have to write up a readme for you guys here. I will have to write up a readme for you guys here.
I will include how-tos for editing the messages and a list of what the template message expect for if you want to edit them. I will include how-tos for editing the messages and a list of what the template message expect for if you want to edit them.
## Setting up VSCode
### Setting up VSCode
- download visual studios code - download visual studios code
- install git - install git
- open git bash and run the two commands (you can choose your own name and email, email doesn't need to be real) - open git bash and run the two commands (you can choose your own name and email, email doesn't need to be real)
- git config --global user.name "dakiny" - git config --global user.name "dakiny"
- git config --global user.email "na@dakiny.com" - git config --global user.email "na@dakiny.com"
- restart vscode - restart vscode
- got to the source control tab on the left hand side - got to the source control tab on the left hand side
- clone this directory - clone this directory
## Discord Tagging
Unless special circumstance (council), I would like to bot to just provide ids rather than a formatted string to tag
things correctly. Here is how you can format your messages correctly to tag stuff.
- Users: <@id_goes_here>
- Roles: <@&id_goes_here>
- Channels: <#id_goes_here>
## Formatting and emotes
If you need a special format (bold) or an emoji, the best way to get it is to type the message exactly how you want
it to look like in discord and then right click `copy text`. This will give you exactly what needs to be types to
show a message how you would like.
## Template message placeholders
Placeholders are used to insert information that changes with each election (currently). It can also represent
information that needs to be gathered at the time of creating/updating the message (once messages not used in eleciton
cycle are added.) All placeholders must be between brackets: {}. If you would like to add a new placeholder, let me
know.
### List of Placeholders:
- {clan_council_elect_role_id}: Clan council elect discord role id.
- {clan_council_id}: Clan council discord role id.
- {clan_leader}: The current clan leader's discord id.
- {clan_member_id}: Clan member discord role id.
- {council}: A list of council member discord ids separated by newlines.
- Note: This once is special and is already formatted to correctly tag the ids.
- {discord_manager}: The current discord manager's discord id.
- {election_start}: Month/day for the start of the election.
- {high_council_id}: High Council discord role id.
- {highcouncil_election_announce}: Month/day for announcing intention to join High Council.
- {highcouncil_election_end}: Month/day for the end of High Council voting.
- {highcouncil_election_start}: Month/day for the start of High Council voting.
- {highcouncil_election}: Same as {highcouncil_election_start}. I probably should make the names the same...
- {next_election_start}: Month/day for the start of the next election.
- {quarter}: The name of the quarter.
- {term_end}: Month/day for the end of term.
- {term_start}: Month/day for the start of term.
- {voting_end_day}: Day of the week that voting ends on.
- {voting_end}: Month/day for the end of voting.
- {voting_start}: Month/day for the start of voting.
### Special placeholder:
- ---message_break---: used to split up large messages. Only used in election_announcement currently.