[doc] Added 'README.md' file.

This commit is contained in:
Lunovox 2024-11-21 21:18:41 -03:00
parent fa3fbe3602
commit 51f2531b26
4 changed files with 131 additions and 0 deletions

131
README.md Normal file
View file

@ -0,0 +1,131 @@
![screenshot_general]
Badge: [![ContentDB_en_icon]][ContentDB_en_link] [![DownloadsCDB_en_icon]][DownloadsCDB_en_link]
# [COMPUTING][mod_computing]
[![luanti_icon]][luanti_link] Add multiple computing devices such as: Smartphones and Desktops.
-----------------------------------------
## 📦 **Itens adicionados:**
| Item | Descryption |
| :--: | :-- |
| 📱<br/>```Phone``` | Mobile device that displays the server date and time. It supports several apps integrated by other mods. |
-----------------------------------------
## 🍰 **Recipes:**
### **Without 'components' mod:**
![screenshot_recipe_1]
### **With 'components' mod:**
![screenshot_recipe_2]
-----------------------------------------
## 📦 **Depends:**
| Mod Name | Dependency Type | Descryption |
| :--: | :--: | :-- |
| default | Mandatory | Minetest Game Included. |
| keys | Mandatory | Minetest Game Included. |
| [components][mod_components] | Optional | It makes the recipe for computational devices more realistic and it is harder to get the ingredients to craft them. |
-----------------------------------------
## 📀 **Mods with Apps:**
These mods are not mandatory. But, because they are integrated into the 'computing' mod, they extend the functionality.
| Mod Name | Descryption |
| :--: | :-- |
| [correio][mod_correio] | Add an app that allows you to read emails. |
| [minertrade][mod_minertrade] | Add an app that allows you to carry out banking operations, with: balance, statement, and money transfers. |
| [lunoschedule][mod_lunoschedule] | Add an app that displays a calendar with four seasons of 28 days each. |
| [soundchat][mod_soundchat] | Add applications that allow you to: configure the chat sound (ideal for those with ADHD), view the conversation history (Ideal for those who play luanti/minetest on their cell phones), start a local chat (between players located close to each other on the map), start a private player-to-player chat with infinite distances). |
-----------------------------------------
## 📜 **License:**
* [![license_code_icon]][license_code_link]
* [![license_media_icon]][license_media_link]
See more details in wiki:
[![wiki_en_icon]][wiki_en_link] [![wiki_pt_icon]][wiki_pt_link]
-----------------------------------------
## 👑 **Developers:**
* Lunovox Heavenfinder: [email](mailto:lunovox@disroot.org), [social web](https://qoto.org/@lunovox), [WebChat](https://cloud.disroot.org/call/9aa2t7ib), [xmpp](xmpp:lunovox@disroot.org?join), [audio conference](mumble:mumble.disroot.org), [more contacts](https://libreplanet.org/wiki/User:Lunovox)
-----------------------------------------
## 💾 **Downloads:**
* [Stable Versions][download_stable] : There are several versions in different stages of completion. Usually recommended for servers because they are more secure.
* [Git Repository (Unstable)][download_repository] : It is the version currently under construction. There may be some stability if used on servers. It is only recommended for testers and mod developers.
-----------------------------------------
## 👄 **Translates:**
See more details in file: [locale/README.md]
-----------------------------------------
## ⚙️ **Settings:**
In **minetest.conf** file:
You don't need to do any of these presets mentioned below to make this mod work. But it's worth knowing the configuration values in case you want to directly change the ````minetest.conf```` file.
| Settings | Descryption |
| :-- | :-- |
| ````computing.debug = <boolean>```` | If show debug info of this mod. Only util to developers. Default: ````false````. |
| ````computing.smartphone_recipe = <boolean>```` | If enabled will display the recipe so players can craft their own smart phone. Default: ````true````. |
-----------------------------------------
[ContentDB_en_icon]:https://content.luanti.org/packages/Lunovox/computing/shields/title/
[ContentDB_en_link]:https://content.luanti.org/packages/Lunovox/computing/
[DownloadsCDB_en_icon]:https://content.luanti.org/packages/Lunovox/computing/shields/downloads/
[DownloadsCDB_en_link]:https://gitlab.com/lunovox/computing/-/tags
[license_code_icon]:https://img.shields.io/static/v1?label=LICENSE%20CODE&message=GNU%20AGPL%20v3.0&color=yellow
[license_code_link]:https://gitlab.com/lunovox/computing/-/raw/main/LICENSE_CODE
[license_media_icon]:https://img.shields.io/static/v1?label=LICENSE%20MEDIA&message=CC%20BY-SA-4.0&color=yellow
[license_media_link]:https://gitlab.com/lunovox/computing/-/raw/main/LICENSE_MEDIA
[locale/README.md]:https://gitlab.com/lunovox/computing/-/tree/master/locale?ref_type=heads
[luanti_icon]:https://img.shields.io/static/v1?label=Minetest&message=Mod&color=brightgreen
[luanti_link]:https://luanti.org
[mod_components]:https://gitlab.com/lunovox/components
[mod_computing]:https://gitlab.com/lunovox/computing
[mod_correio]:https://gitlab.com/lunovox/correio
[mod_minertrade]:https://gitlab.com/lunovox/minertrade
[mod_lunoschedule]:https://gitlab.com/Lunovox/lunoschedule
[mod_soundchat]:https://gitlab.com/Lunovox/soundchat
[download_stable]:https://gitlab.com/lunovox/computing/-/tags
[download_repository]:https://gitlab.com/lunovox/computing
[screenshot_general]:https://gitlab.com/lunovox/computing/-/raw/main/screenshot.png
[screenshot_recipe_1]:https://gitlab.com/lunovox/computing/-/raw/main/textures/screenshot_recipe_1.png
[screenshot_recipe_2]:https://gitlab.com/lunovox/computing/-/raw/main/textures/screenshot_recipe_2.png
[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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 309 KiB

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB