Mirrored_Repos/veloren
1
0
Fork 0
mirror of https://gitlab.com/veloren/veloren.git synced 2024-08-30 18:12:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
walpo 2023-05-02 19:48:27 +00:00 committed by Marcel
parent b37a2bf1c7
commit de90639e84
1 changed files with 30 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -5,56 +5,67 @@
[![pipeline status](https://gitlab.com/veloren/veloren/badges/master/pipeline.svg)](https://gitlab.com/veloren/veloren/commits/master) [![pipeline status](https://gitlab.com/veloren/veloren/badges/master/pipeline.svg)](https://gitlab.com/veloren/veloren/commits/master)
[![coverage report](https://gitlab.com/veloren/veloren/badges/master/coverage.svg)](https://gitlab.com/veloren/veloren/commits/master) [![coverage report](https://gitlab.com/veloren/veloren/badges/master/coverage.svg)](https://gitlab.com/veloren/veloren/commits/master)
[![license](https://img.shields.io/github/license/veloren/veloren.svg)](https://gitlab.com/veloren/veloren/blob/master/LICENSE) [![license](https://img.shields.io/github/license/veloren/veloren.svg)](https://gitlab.com/veloren/veloren/blob/master/LICENSE)
[![discord](https://img.shields.io/discord/449602562165833758.svg)](https://discord.gg/WEXSY9h) [![discord](https://img.shields.io/discord/449602562165833758.svg)](https://discord.gg/veloren-community-449602562165833758)
[![lines of code](https://tokei.rs/b1/gitlab/veloren/veloren)](https://tokei.rs/b1/gitlab/veloren/veloren) [![lines of code](https://tokei.rs/b1/gitlab/veloren/veloren)](https://tokei.rs/b1/gitlab/veloren/veloren)
[![contributor count](https://img.shields.io/github/contributors/veloren/veloren)](https://gitlab.com/veloren/veloren/-/graphs/master) [![contributor count](https://img.shields.io/github/contributors/veloren/veloren)](https://gitlab.com/veloren/veloren/-/graphs/master)
## Welcome To Veloren! ## Welcome to Veloren!
Veloren is a multiplayer voxel RPG written in Rust. Veloren takes inspiration from games such as Cube World, Minecraft and Dwarf Fortress. The game is currently under heavy development, but is playable. Veloren is a multiplayer voxel RPG written in Rust. It is inspired by games such as Cube World, The Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft. The game is in active development and enjoys a flourishing player community.
## Development ## Development
Currently the communication of contributors happens mainly on our [official Discord server](https://discord.gg/kjwJwjK). You can join it to keep up with the development, talk to us or contribute something yourself. Anyone who shows genuine effort to help is welcome in our team. You don't have to know how to program to contribute! Currently, most communication among contributors takes place on our [official Discord server](https://discord.gg/veloren-community-449602562165833758). You can join it to keep up with the game development, talk to us or even contribute something yourself. Anyone who shows genuine effort to help is welcome in our team. You do not need to know how to code to contribute to the game!
## Useful Links ## Useful links
[Sign Up](https://veloren.net/account/) - Here you can create an online account for Veloren. [Sign up](https://veloren.net/account/) - Here you can create an official account for Veloren.
This will be needed to play on auth-enabled servers, including the official server. Most Veloren servers require you to register with the official authentication server to play.
[The Book](https://book.veloren.net) - A collection of all important information relating to Veloren. It includes information on how to compile Veloren and how to contribute. <details>
<summary>Click here for more details about authentication</summary>
The official authentication server uses TLS encryption extensively. It also employs salted hashing to ensure your login credentials are stored securely. Additionally, the server neither tracks any metrics nor uses data for any purpose other than providing the authentication service.
</details>
[Future Plans](https://gitlab.com/veloren/veloren/-/milestones) - Go here for information about Veloren's development roadmap and what we're currently working on. [The wiki](https://wiki.veloren.net) - The official wiki which provides various information about the game.
#### Official social media and websites [The book](https://book.veloren.net) - The book is a collection of supplementary information about the game. It includes instructions on how to compile the game.
[Future plans](https://gitlab.com/veloren/veloren/-/milestones) - This is the development roadmap and what issues the community is currently working on.
### Official social media and websites
- [Website](https://veloren.net) - [Website](https://veloren.net)
- [Discord Server](https://discord.gg/kjwJwjK) - [Discord server](https://discord.gg/veloren-community-449602562165833758)
- [Matrix server](https://matrix.to/#/#veloren-space:fachschaften.org)
- [Subreddit](https://www.reddit.com/r/Veloren) - [Subreddit](https://www.reddit.com/r/Veloren)
## Get Veloren ## Get Veloren
We provide 64-bit builds for Linux, Mac, and Windows, which can be downloaded on the official website: We provide builds for Windows, macOS and Linux. The game can be downloaded on the official website:
[https://www.veloren.net/download/](https://veloren.net/download/)
Due to rapid development stable versions become outdated fast and might be **incompatible with the public server**. [https://veloren.net/download/](https://veloren.net/download/)
If you want to compile Veloren yourself, follow the instructions in our [Book](https://book.veloren.net/contributors/introduction.html). Due to rapid game development, stable versions become outdated fast and might be **incompatible with the public server**.
It is recommended to use [Airshipper](https://book.veloren.net/players/airshipper.html), our official launcher, to keep your game up-to-date easily.
If you prefer to compile the game yourself, follow the instructions in our [book](https://book.veloren.net/contributors/introduction.html).
## F.A.Q. ## F.A.Q.
### **Q:** How is this game licensed? ### **Q:** How is this game licensed?
**A:** **It's free to play, modify and distribute. Forever.** Since it is a community project, we decided to license it under the **GNU GPL 3.0** license which means it will always stay free and open source. **A:** **It is free to play, modify and distribute. Forever.** Since it is a community project, we decided to license it under the **[GNU GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.txt)** license which means it will always stay free and open source.
### **Q:** What platforms are supported? ### **Q:** What platforms are supported?
**A:** Veloren can run on Windows, Linux and Mac OS on all architectures (although x86_64 is our main focus). It's probably possible to compile Veloren on/for BSD, Fuchsia and others as well. **A:** Veloren can run on Windows, macOS and Linux, on all CPU architectures. However, the x86_64 architecture is the main focus in development. Official builds for the ARM64 architecture are also provided for macOS and Linux. It is likely possible to compile the game on other platforms as well.
### **Q:** Do you accept donations? ### **Q:** Do you accept donations?
**A:** You can support the project on our [OpenCollective Page](https://opencollective.com/veloren). **A:** You can support the project on our [Open Collective](https://opencollective.com/veloren) page.
## Credit ## Credit
Many thanks to everyone that has contributed to Veloren's development, provided ideas, crafted art, composed music, hunted bugs, created tools and supported the project. Many thanks to everyone who has contributed to Veloren's source code, provided ideas for the game, crafted game art, composed music, hunted bugs, created tools and, overall, supported the project.