mirror of
https://gitlab.com/veloren/veloren.git
synced 2025-07-26 05:12:29 +00:00
Update documentation
This commit is contained in:
Javier Pérez
Marcel
@ -1,73 +0,0 @@
|
||||
# The Veloren Code of Conduct
|
||||
|
||||
**Contact**: `@Admin` or `@Core developers` on discord or [info@veloren.net](mailto:info@veloren.net)
|
||||
|
||||
## Conduct
|
||||
|
||||
- We are committed to providing a friendly, safe and welcoming environment for
|
||||
all, regardless of level of experience, gender identity and expression, sexual
|
||||
orientation, disability, personal appearance, body size, race, ethnicity, age,
|
||||
religion, nationality, or other similar characteristics.
|
||||
- Please be kind and courteous. There's no need to be rude.
|
||||
- We will exclude you from interaction if you insult, demean or harass anyone.
|
||||
That is not welcome behavior; we strive to be inclusive. In particular, we
|
||||
don't tolerate behavior that excludes people in socially marginalized groups.
|
||||
- If you feel you are being harassed, or someone else's actions have made you
|
||||
uncomfortable, please **contact** us.
|
||||
Whether you're a regular contributor or a newcomer, we care about making this
|
||||
community a safe place for you and we've got your back. If the offender was
|
||||
an admin or core developer, use [report@veloren.net](mailto:report@veloren.net).
|
||||
Emails send to this address will be forwarded only to one person appointed to
|
||||
handle those issues.
|
||||
- Respect that people have differing opinions and that every design or
|
||||
implementation choice carries a trade-offs. There is seldom one right answer.
|
||||
- Please keep unstructured critique to a minimum. If you have solid ideas you
|
||||
want to experiment with, make a branch and see how it works.
|
||||
- This community exists to focus on Veloren, keep off-topic content to the
|
||||
respective channels.
|
||||
|
||||
## Moderation
|
||||
|
||||
These are the policies for upholding our community's standards of conduct. If
|
||||
you feel that a discussion needs moderation, please **contact** us.
|
||||
|
||||
1. Any remarks that violate the Veloren standards of conduct, are not allowed
|
||||
and will result in a ban.
|
||||
2. Remarks that moderators find inappropriate, whether listed in the code of
|
||||
conduct or not, are also not allowed.
|
||||
In this case moderators will respond with a warning, kick, ban scheme if
|
||||
the user continues to make trouble.
|
||||
3. Moderators may choose at their discretion to un-ban the user if it was a
|
||||
first offence, and they offer the offended party a genuine apology.
|
||||
4. If a moderator bans someone, and you think it was unjustified, please take it
|
||||
up with that moderator, or with a different moderator, **in private**.
|
||||
Complaints about bans are not allowed on our public channels.
|
||||
5. Moderators, organization members, and anyone closely involved with the
|
||||
Veloren project are held to a higher standard than other community members.
|
||||
If a moderator creates an inappropriate situation, they should expect less
|
||||
leeway than others.
|
||||
|
||||
In the Veloren community we strive to go the extra step to look out for each
|
||||
other. Don't just aim to be technically unimpeachable, try to be your best self.
|
||||
Be careful when you speak about offensive or sensitive issues, particularly
|
||||
if they're off-topic; this all too often leads to unnecessary fights, hurt
|
||||
feelings, and damaged trust; worse, it can drive people away from the community
|
||||
entirely.
|
||||
|
||||
If you have been called out for violating this code, resist the urge to be
|
||||
defensive. Just stop doing what it was they complained about and apologize. Even
|
||||
if you feel you were misinterpreted or unfairly accused, chances are good there
|
||||
was something you could've communicated better — remember that it's your
|
||||
responsibility to make your fellow Veloren community members comfortable.
|
||||
Everyone wants to get along and we are all here first and foremost because we
|
||||
want to talk about making games. You will find that people will be eager to
|
||||
assume good intent and forgive as long as you earn their trust.
|
||||
|
||||
The enforcement policies listed above apply to all official Veloren venues;
|
||||
including all Veloren Discord channels; in-game chat; Gitlab and GitHub repositories under
|
||||
Veloren; and any other social media platforms related to Veloren.
|
||||
|
||||
This Code of Conduct is based on the Amethyst Code of Conduct, available
|
||||
[here](https://github.com/amethyst/amethyst/blob/master/CODE_OF_CONDUCT.md)
|
||||
which is based on the Rust Code of Conduct, available
|
||||
[here](https://www.rust-lang.org/conduct.html).
|
||||
@ -1,9 +1,10 @@
|
||||
# Contributing
|
||||
|
||||
To learn about how to contribute, take a look at the [Veloren book](https://book.veloren.net).
|
||||
|
||||
# Guidelines
|
||||
## Guidelines
|
||||
|
||||
## Do not commit tainted content to the repository
|
||||
### Do not commit tainted content to the repository
|
||||
|
||||
If you commit anything that was not created by yourself, double check that the license for that content permits to be distributed under our license.
|
||||
|
||||
|
||||
89
README.md
89
README.md
@ -1,78 +1,107 @@
|
||||
# 
|
||||
|
||||
[](https://veloren.net/discord)
|
||||
[](https://veloren.net/zulip)
|
||||
[](https://gitlab.com/veloren/veloren/-/pipelines)
|
||||
[](https://gitlab.com/veloren/veloren/-/graphs/master/charts)
|
||||
[](https://translate.codeberg.org/engage/veloren/)
|
||||
[](https://deps.rs/repo/gitlab/veloren/veloren)
|
||||
[](https://gitlab.com/veloren/veloren/-/graphs/master)
|
||||
[](https://opencollective.com/veloren)
|
||||
[](https://discord.gg/veloren-community-449602562165833758)
|
||||
[](https://gitlab.com/veloren/veloren/-/graphs/master)
|
||||
[](https://opencollective.com/veloren)
|
||||
|
||||
<a href="https://opencollective.com/veloren/donate?interval=month&amount=5" target="_blank">
|
||||
<img src="https://opencollective.com/veloren/contribute/button@2x.png?color=blue" width="29%">
|
||||
<a href="https://veloren.net/donate" target="_blank">
|
||||
<img src="https://opencollective.com/veloren/contribute/button@2x.png?color=blue" width="29%" alt="Donate to the Veloren project on Open Collective">
|
||||
</a>
|
||||
|
||||
## Welcome to Veloren!
|
||||
|
||||
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.
|
||||
Veloren is an action-adventure RPG game set in a vast fantasy world. It is inspired by other games such as Cube World, The Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft.
|
||||
|
||||
Veloren is in active development and enjoys a flourishing player community.
|
||||
|
||||
## Development
|
||||
|
||||
Currently, most communication among contributors takes place on our [official Discord server](https://discord.gg/veloren-community-449602562165833758). Similarly, we provide a [Matrix server](https://matrix.to/#/#veloren-space:fachschaften.org) as a more privacy-friendly alternative. You can join it to keep up with the game development, talk with the community or even contribute something yourself. Anyone who shows genuine effort to help is welcome to our team. You do not need to know how to code to contribute to the game!
|
||||
You are welcome to join either our [Discord server](https://veloren.net/discord) or our [Zulip server](https://veloren.net/zulip) to chat with the community.
|
||||
|
||||
Translators are welcome to contribute on our Weblate instance.
|
||||
We accept many types of contributions, not only from software developers!
|
||||
For example, players who submit their feedback and artists who share their artworks with the community.
|
||||
|
||||
Translators are also welcome to contribute on our Weblate instance.
|
||||
|
||||
<a href="https://translate.codeberg.org/engage/veloren/">
|
||||
<img src="https://translate.codeberg.org/widgets/veloren/-/open-graph.png" alt="Translation status" width="55%">
|
||||
<img src="https://translate.codeberg.org/widgets/veloren/-/open-graph.png" alt="Translation status on Weblate" width="55%">
|
||||
</a>
|
||||
|
||||
## Useful links
|
||||
|
||||
[Sign up](https://veloren.net/account/) - Here you can create an official account for Veloren.
|
||||
Most Veloren servers require you to register with the official authentication server to play.
|
||||
[Sign up](https://veloren.net/account) -
|
||||
Create an account to play on most Veloren multiplayer servers.
|
||||
|
||||
<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.
|
||||
<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>
|
||||
|
||||
[The wiki](https://wiki.veloren.net) - The official wiki which provides various information about the game.
|
||||
[The wiki](https://wiki.veloren.net) -
|
||||
Information repository about the game made by and for players.
|
||||
|
||||
[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.
|
||||
[The book](https://book.veloren.net) -
|
||||
Supplementary information useful both for players and contributors.
|
||||
|
||||
[Future plans](https://gitlab.com/veloren/veloren/-/milestones) - This is the development roadmap and what issues the community is currently working on.
|
||||
[Future plans](https://gitlab.com/veloren/veloren/-/milestones) -
|
||||
Development roadmap and issue tracker.
|
||||
|
||||
[Code of conduct](https://veloren.net/code-of-conduct) -
|
||||
Policies our moderators enforce to ensure a healthy and safe environment for everyone in the community.
|
||||
|
||||
### Official social media and websites
|
||||
|
||||
[](https://veloren.net)<br/>
|
||||
[](https://discord.gg/veloren-community-449602562165833758)<br/>
|
||||
[](https://matrix.to/#/#veloren-space:fachschaften.org)<br/>
|
||||
[](https://floss.social/@veloren)<br/>
|
||||
[](https://www.reddit.com/r/Veloren)<br/>
|
||||
[](https://youtube.com/@Veloren)<br/>
|
||||
[](https://www.twitch.tv/veloren_dev)<br/>
|
||||
[](https://veloren.net)
|
||||
<br>
|
||||
[](https://veloren.net/discord)
|
||||
<br>
|
||||
[](https://veloren.net/zulip)
|
||||
<br>
|
||||
[](https://floss.social/@veloren)
|
||||
<br>
|
||||
[](https://www.reddit.com/r/Veloren)
|
||||
<br>
|
||||
[](https://www.youtube.com/veloren)
|
||||
<br>
|
||||
[](https://www.twitch.tv/veloren_dev)
|
||||
|
||||
## Get Veloren
|
||||
|
||||
We provide builds for Windows, macOS and Linux. The game can be downloaded on the official website:
|
||||
We provide builds for Windows, macOS and Linux.
|
||||
The game can be downloaded on our website:
|
||||
|
||||
[https://veloren.net/download/](https://veloren.net/download/)
|
||||
<https://veloren.net/download>
|
||||
|
||||
Due to rapid game development, stable versions become outdated fast and might be **incompatible with the public server**.
|
||||
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.
|
||||
It is recommended to use [Airshipper](https://book.veloren.net/players/airshipper.html),
|
||||
the official game 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).
|
||||
If you prefer to compile the game yourself, follow the instructions
|
||||
in our [book](https://book.veloren.net/contributors/introduction.html).
|
||||
|
||||
## FAQ
|
||||
|
||||
### **Q:** How is this game licensed?
|
||||
|
||||
**A:** **It is free to play, modify and distribute. Forever.** Since it is a community project, we decided to license it under the **[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html)**, 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 General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html)**,
|
||||
which means it will always stay free and open source.
|
||||
|
||||
### **Q:** What platforms are supported?
|
||||
|
||||
**A:** Veloren can run on Windows, macOS and Linux on a great range of 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.
|
||||
**A:** Veloren can run on Windows, macOS and Linux on a great range of 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?
|
||||
|
||||
|
||||
@ -17,48 +17,32 @@
|
||||
<content_attribute id="violence-fantasy">mild</content_attribute>
|
||||
</content_rating>
|
||||
|
||||
<summary>
|
||||
Veloren is a multiplayer voxel RPG written in Rust. It is inspired by games
|
||||
such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and
|
||||
Minecraft.
|
||||
</summary>
|
||||
<summary xml:lang="de">
|
||||
Veloren ist ein in Rust geschriebenes Mehrspieler Voxel RPG. Es wurde von
|
||||
Spielen wie Cube World, The Legend of Zelda: Breath of the Wild, Dwarf
|
||||
Fortress und Minecraft inspiriert.
|
||||
</summary>
|
||||
<summary>Veloren is an action RPG set in a vast fantasy world made of voxels</summary>
|
||||
<summary xml:lang="de">Veloren ist ein Action-RPG, das in einer riesigen Fantasiewelt aus Voxeln spielt</summary>
|
||||
|
||||
<description>
|
||||
<p>Welcome To Veloren!</p>
|
||||
<p xml:lang="de">Willkommen bei Veloren!</p>
|
||||
|
||||
<p>
|
||||
Welcome To Veloren!
|
||||
</p><p xml:lang="de">
|
||||
Willkommen bei Veloren!
|
||||
</p><p>
|
||||
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.
|
||||
</p><p xml:lang="de">
|
||||
Veloren ist ein in Rust geschriebenes Mehrspieler Voxel RPG. Es wurde
|
||||
von Spielen wie Cube World, Minecraft und Dwarf Fortress inspiriert.
|
||||
Das Spiel befindet sich mommentan noch in Entwicklung, ist aber bereits
|
||||
spielbar.
|
||||
</p><p>
|
||||
Development
|
||||
</p><p xml:lang="de">
|
||||
Entwicklung
|
||||
</p><p>
|
||||
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!
|
||||
</p><p xml:lang="de">
|
||||
Aktuell findet die Kommunikation zwischen Beitragenden hauptsächlich auf
|
||||
unserem offiziellen Discord (https://discord.gg/kjwJwjK) Server statt.
|
||||
Du kannst beitreten um Neuigkeiten über die Entwicklung zu erhalten, mit
|
||||
uns zu reden oder selbst etwas beizutragen. Jeder, der sich bemüht zu helfen
|
||||
ist in unserem Team willkommen. Du musst nicht wissen wie man programmiert,
|
||||
um etwas beizutragen.
|
||||
Veloren is an action-adventure RPG game set in a vast fantasy world.
|
||||
It is inspired by other games such as Cube World,
|
||||
The Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft.
|
||||
</p>
|
||||
<p xml:lang="de">
|
||||
Veloren ist ein Action-Adventure-Rollenspiel, das in einer riesigen Fantasiewelt spielt.
|
||||
Es ist inspiriert von anderen Spielen wie Cube World,
|
||||
The Legend of Zelda: Breath of the Wild, Dwarf Fortress und Minecraft.
|
||||
</p>
|
||||
|
||||
<h2>Development</h2>
|
||||
<h2 xml:lang="de">Entwicklung</h2>
|
||||
|
||||
<p>
|
||||
You are welcome to join our [Zulip server](https://veloren.net/zulip) to chat with the community.
|
||||
</p>
|
||||
<p xml:lang="de">
|
||||
Du bist herzlich eingeladen, unserem [Zulip-Server] (https://veloren.net/zulip) beizutreten und mit der Community zu chatten.
|
||||
</p>
|
||||
</description>
|
||||
|
||||
@ -68,16 +52,16 @@
|
||||
|
||||
<screenshots>
|
||||
<screenshot type="default">
|
||||
<image>https://media.discordapp.net/attachments/634860358623821835/884138091537907793/screenshot_1630865233900.png</image>
|
||||
<image>https://s3.eu-central-2.wasabisys.com/veloren-blog/cdn/634860358623821835/884138091537907793/screenshot_1630865233900.png</image>
|
||||
</screenshot>
|
||||
<screenshot>
|
||||
<image>https://media.discordapp.net/attachments/634860358623821835/885141629902684180/bg_12.jpg</image>
|
||||
<image>https://s3.eu-central-2.wasabisys.com/veloren-blog/cdn/634860358623821835/885141629902684180/bg_12.jpg</image>
|
||||
</screenshot>
|
||||
<screenshot>
|
||||
<image>https://media.discordapp.net/attachments/634860358623821835/884297602462539876/screenshot_1630903166427.png</image>
|
||||
<image>https://s3.eu-central-2.wasabisys.com/veloren-blog/cdn/634860358623821835/884297602462539876/screenshot_1630903166427.png</image>
|
||||
</screenshot>
|
||||
<screenshot>
|
||||
<image>https://media.discordapp.net/attachments/634860358623821835/885141632519905330/bg_10.jpg</image>
|
||||
<image>https://s3.eu-central-2.wasabisys.com/veloren-blog/cdn/634860358623821835/885141632519905330/bg_10.jpg</image>
|
||||
</screenshot>
|
||||
</screenshots>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user