sixam/eurn
1
0
Fork 0
mirror of https://gitlab.com/lunovox/e-urn.git synced 2025-03-15 07:21:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[docs] update README.md and settingtypes.txt

Browse source
This commit is contained in:
Lunovox 2024-02-21 23:23:41 -03:00
parent e8d5b17425
commit cd7f429a26
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -23,8 +23,11 @@ Colect opinion of player with electronic urn.
| :--: | :--: | :-- |
| default | Mandatory | Minetest Game Included. |
## **Commands:**
These commands are not mandatory for you to use this mod. To do the same, you can use the graphical mode of the electronic voting machine and the voter registration card.
| Command | Parameter | Descryption |
| :-- | :--: | :-- |
| ````/president```` | ````[<candidate_name>]```` | Show or Select the presidente of the server. Need the ````electoraljudge```` privilege. |
@ -37,11 +40,28 @@ Colect opinion of player with electronic urn.
| ````/votes```` | | Show the name of all candidates for president with the amount of votes. Need the ````electoraljudge```` privilege. |
| ````/election```` | | Apply presidential selection vote counting! Need the ````electoraljudge```` privilege. |
## **API:**
* ````<array> modEUrn.getPresidentCandidates()```` : Return a array with name of all presidente candidates of the server. Return empty array if not exist.
* ````<string/nil> modEUrn.getPresidentName()```` : Return a string with the presidente name of the server. Return nil if not exist.
* ````modEUrn.doSave()```` : Save database em file ````e-urm.db````.
Extras are functions of this mod that you can use in another mod you create. For example: "create a mod that gives a special power or privilege that only the elected president can enjoy"
| Function | Descryption |
| :--: | :-- |
| ````<array> modEUrn.getPresidentCandidates()```` | Return a array with name of all presidente candidates of the server. Return empty array if not exist.
| ````<string/nil> modEUrn.getPresidentName()```` | Return a string with the presidente name of the server. Return nil if not exist.
| ````modEUrn.doSave()```` | Save database em file ````e-urm.db````.
## **CONFIGURATION:**
You don't need to worry about the settings below to make this mod work. But, if you want to configure, you can change the settings through the graphical menu, or you can change them directly by editing the 'minetest.conf' file.
| Function | Descryption |
| :--: | :-- |
| ````eurn.debug = <true/false>```` | Allows you to print the debug information of this mod on the screen. Default: false |
| ````eurn.save_compressed = <true/false>```` | Whether the database will be BASE64 compressed. If enabled will save database bank without compression in file '.db'. Default: true |
| ````eurn.voter.min_played_hours = <number>```` | Minimum game time in hours to become a voter. Default: 90 | Min: 0 | Max: 8760 |
[urn_front]:textures/text_eurn_front.png

3
settingtypes.txt
View file

@ -5,8 +5,7 @@ eurn.debug (Show E-Urn Debug) bool false
# E-URN:
# Whether the database will be BASE64 compressed.
# If enabled will save database bank in file '.db64',
# else in file '.tbl' without compression.
# If enabled will save database bank without compression in file '.db'.
# Default: true
eurn.save_compressed (Database Compressed) bool true