README.md 3.75 KB
Newer Older
Timo Kösters's avatar
Timo Kösters committed
1
<p align="center">
Forest Anderson's avatar
Forest Anderson committed
2
	<img alt="Veloren logo on a screenshot" src="https://cdn.discordapp.com/attachments/541307708146581519/712295605170602075/logo.png">
Timo Kösters's avatar
Timo Kösters committed
3
</p>
Joshua Barretto's avatar
Joshua Barretto committed
4

Forest Anderson's avatar
Forest Anderson committed
5 6 7 8
[![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)
[![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)
Forest Anderson's avatar
Forest Anderson committed
9
[![lines of code](https://tokei.rs/b1/gitlab/veloren/veloren)](https://tokei.rs/b1/gitlab/veloren/veloren)
10
[![contributor count](https://img.shields.io/github/contributors/veloren/veloren)](https://gitlab.com/veloren/veloren/-/graphs/master)
Forest Anderson's avatar
Forest Anderson committed
11

Timo Kösters's avatar
Timo Kösters committed
12 13 14 15 16 17 18 19 20 21
## 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.

## 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!

## Useful Links

Marcel's avatar
Marcel committed
22
[Sign Up](https://veloren.net/account/) - Here you can create an online account for Veloren.
Acrimon's avatar
Acrimon committed
23 24
This will be needed to play on auth-enabled servers, including the official server.

Timo Kösters's avatar
Timo Kösters committed
25 26
[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.

theduke's avatar
theduke committed
27
[Future Plans](https://gitlab.com/veloren/veloren/-/milestones) - Go here for information about Veloren's development roadmap and what we're currently working on.
Timo Kösters's avatar
Timo Kösters committed
28 29 30 31 32 33 34 35 36

#### Official social media and websites

- [Website](https://veloren.net)
- [Discord Server](https://discord.gg/kjwJwjK)
- [Subreddit](https://www.reddit.com/r/Veloren)

## Get Veloren

James Tai's avatar
James Tai committed
37
We provide 64-bit builds for Linux, Mac, and Windows, which can be downloaded on the official website:
38
[https://www.veloren.net](https://veloren.net/welcome)
Mckol's avatar
Mckol committed
39 40

Due to rapid developement stable versions become outdated fast and might be **incompatible with the public server**.
Timo Kösters's avatar
Timo Kösters committed
41

42
If you want to compile Veloren yourself, follow the instructions in our [Book](https://book.veloren.net/contributors/introduction.html).
Timo Kösters's avatar
Timo Kösters committed
43 44

## F.A.Q.
Forest Anderson's avatar
Forest Anderson committed
45

Timo Kösters's avatar
Timo Kösters committed
46 47 48 49 50 51
### **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.

### **Q:** What platforms are supported?

Mckol's avatar
Mckol committed
52
**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.
Timo Kösters's avatar
Timo Kösters committed
53 54 55

### **Q:** Do you accept donations?

Songtronix's avatar
Songtronix committed
56
**A:** You can support the project on our [OpenCollective Page](https://opencollective.com/veloren).
Timo Kösters's avatar
Timo Kösters committed
57 58 59 60

## 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.
Acrimon's avatar
Acrimon committed
61 62 63 64 65 66 67 68 69 70

## Sponsorship

<a href="https://www.digitalocean.com?utm_medium=opensource&utm_source=Veloren">
	<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg" width="201px">
</a>

We are extremely proud to be sponsored by [Digital Ocean](https://www.digitalocean.com).

Their support allows us to build and reliably power our shared backend services.