eurn/README.md
2024-02-21 06:51:57 -03:00

62 lines
No EOL
3.3 KiB
Markdown

![urn_front]
# [E-URN]
[![minetest_icon]][minetest_link] [![baixa_icon]][baixa_link] [![projeto_icon]][projeto_link] <!-- [![bower_icon]][bower_link] -->
Colect opinion of player with electronic urn.
## **License:**
* [![license_icon]][license_link]
More details:
[![wiki_en_icon]][wiki_en_link] [![wiki_pt_icon]][wiki_pt_link]
## **Developers:**
* Lunovox Heavenfinder: [email](mailto:lunovox@disroot.org), [xmpp](xmpp:lunovox@disroot.org?join), [social web](http://qoto.org/@lunovox), [audio conference](https://meet.jit.si/MinetestBrasil), [more contacts](https:libreplanet.org/wiki/User:Lunovox)
## 📦 **Depends:**
| Mod Name | Dependency Type | Descryption |
| :--: | :--: | :-- |
| default | Mandatory | Minetest Game Included. |
## **Commands:**
| Command | Parameter | Descryption |
| :-- | :--: | :-- |
| ````/president```` | ````[<candidate_name>]```` | Show or Select the presidente of the server. Need the ````electoraljudge```` privilege. |
| ````/candidateme```` | ````[<political campaign>]```` | Register your campaign to run for server president. |
| ````/discandidateme```` | | Unregister your campaign to run for server president. |
| ````/candidates```` | | Show the name of all candidates for president. |
| ````/candidate```` or ````/campaign```` | ````[<candidate_name>]```` | Show the Campaign of candidate for president. |
| ````/vote```` | ````[<candidate_name>]```` | Vote for a specific candidate for president. Need a minimum number of hours of online play. |
| ````/unvote```` | | Unvote for presidetial candidate. |
| ````/votes```` | | Show the name of all candidates for president with the amount of votes. Need privilege ````electoraljudge````.
## **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````.
[urn_front]:textures/text_eurn_front.png
[E-URN]:https://gitlab.com/lunovox/e-urn/
[baixa_icon]:https://img.shields.io/static/v1?label=Download&message=Mod&color=blue
[baixa_link]:https://gitlab.com/lunovox/e-urn/-/archive/master/e-urn-master.zip?inline=false
[bower_icon]:https://img.shields.io/badge/Bower-Projeto-green.svg
[bower_link]:https://gitlab.com/lunovox/e-urn/-/raw/master/textures/bower.json
[GNU AGPL-3.0]:https://gitlab.com/lunovox/e-urn/-/raw/master/LICENSE
[license_icon]:https://img.shields.io/static/v1?label=GNU%20AGPL%20v3.0&message=Download&color=yellow
[license_link]:https://gitlab.com/lunovox/e-urn/-/raw/master/LICENSE
[minetest_icon]:https://img.shields.io/static/v1?label=Minetest&message=Game&color=brightgreen
[minetest_link]:https://minetest.net
[projeto_icon]:https://img.shields.io/static/v1?label=Projeto&message=GIT&color=red
[projeto_link]:https://gitlab.com/lunovox/e-urn
[wiki_en_icon]:https://img.shields.io/static/v1?label=GNU%20AGPL%20v3.0&message=EN&color=blue
[wiki_en_link]:https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License
[wiki_pt_icon]:https://img.shields.io/static/v1?label=GNU%20AGPL%20v3.0&message=PT&color=blue
[wiki_pt_link]:https://pt.wikipedia.org/wiki/GNU_Affero_General_Public_License