mirror of
https://git.minetest.land/VoxeLibre/VoxeLibre.git
synced 2025-04-15 20:25:16 +02:00
Rewrite and actualize README.md, add GETTING_STARTED.md
This commit is contained in:
Mikita Wiśniewski
the-real-herowl
parent
af3eaaeac6
commit
288f0162aa
2 changed files with 161 additions and 167 deletions
81
GETTING_STARTED.md
Normal file
81
GETTING_STARTED.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
# Getting Started
|
||||
|
||||
## Installation
|
||||
|
||||
To play VoxeLibre with the best possible performance and support, we recommend
|
||||
using the latest stable version of [Luanti](https://www.luanti.org/). However,
|
||||
we always make an effort to support at least two earlier versions to keep the
|
||||
game playable for everyone. The development versions of Luanti are not supported
|
||||
for gameplay due to their instability, but we encourage developers to run them
|
||||
to ensure faster support for upcoming engine versions.
|
||||
|
||||
To install VoxeLibre (if you haven't already), open your Luanti client, go to
|
||||
the **Content** tab, press **Browse online content** and switch to the **Games**
|
||||
tab located at the top-left corner. From there, find VoxeLibre, open its package
|
||||
page and press **Install**. It's that easy!
|
||||
|
||||
|
||||
## How to play
|
||||
|
||||
### Basic controls
|
||||
|
||||
VoxeLibre makes use of the control scheme provided by Luanti. Depending on your
|
||||
platform (PC, Mobile, or other), the specific keys or buttons corresponding to
|
||||
in-game actions may vary a lot. Open the **Settings** menu, navigate to the
|
||||
**Controls** category and inspect the control scheme from there, tweaking it as
|
||||
you see fit.
|
||||
|
||||
The **Aux1** or **Special** action is assigned to sprinting.
|
||||
|
||||
### Starting out
|
||||
|
||||
* Punch a tree until it breaks and collect its trunk as blocks
|
||||
* Place the tree trunks into the 2×2 grid (the **crafting grid** in your
|
||||
inventory menu) and craft wood planks out of them, 4 blocks per trunk
|
||||
* Place 4 wood planks in a 2×2 shape in the crafting grid to make a **crafting
|
||||
table**
|
||||
* Press <kbd>Place</kbd> (right-click) on the crafting table to access a 3×3
|
||||
crafting grid for more complex recipes
|
||||
* Use the **crafting guide** (book icon) to learn all possible crafting recipes
|
||||
* Craft a **wooden pickaxe** to dig stone and collect cobblestone, essential for
|
||||
many recipes
|
||||
* All tools differ by type and tier. Try out axes, hoes, shovels and swords,
|
||||
crafted by putting different materials in familiar shapes
|
||||
* Continue playing as you wish. Have fun!
|
||||
|
||||
### Farming
|
||||
|
||||
* Find some seeds
|
||||
* Craft a hoe
|
||||
* <kbd>Place</kbd> (right-click) on dirt or a similar block to cultivate it
|
||||
to **farmland**
|
||||
* Place seeds on farmland and watch them grow under light
|
||||
* If near water, farmland becomes wet and speeds up growth
|
||||
* Harvest mature plants for food and replanting
|
||||
|
||||
### Cooking and smelting
|
||||
|
||||
* Craft a **furnace** with 8 blocks of cobblestone
|
||||
* Upper slot must contain a cookable/smeltable item (e.g. potato or raw iron)
|
||||
* Lower slot must contain a fuel item (e.g. coal)
|
||||
* See tooltips in crafting guide to learn about fuels and cookable/smeltable
|
||||
items
|
||||
* Upgrade to specialized blocks to speed it up: a **blast furnace** to smelt
|
||||
metal or a **smoker** to cook food
|
||||
|
||||
### Additional help
|
||||
|
||||
More information about the gameplay, blocks, items and much more can easily be
|
||||
accessed from inside the game. Navigate to the **Help** menu from the inventory
|
||||
and explore VoxeLibre's massive knowledge base.
|
||||
|
||||
### Special items
|
||||
|
||||
The following items are interesting for use in creative mode and for adventure
|
||||
map builders in particular. They cannot be obtained in-game or from the creative
|
||||
inventory.
|
||||
|
||||
* Barrier: `mcl_core:barrier`
|
||||
|
||||
Use the `/giveme` chat command to obtain them. See the in-game help for an
|
||||
explanation.
|
||||
247
README.md
247
README.md
|
|
@ -1,195 +1,108 @@
|
|||
# VoxeLibre
|
||||
A game inspired by Minecraft for Luanti. Forked from MineClone by davedevils.
|
||||
Developed by many people, see CREDITS.md for a complete list.
|
||||
<div align="center">
|
||||
<img src="/VoxeLibre/VoxeLibre/raw/branch/master/menu/icon.png">
|
||||
<h1>VoxeLibre</h1>
|
||||
<a href="https://content.luanti.org/packages/Wuzzy/mineclone2/"><img src="https://content.luanti.org/packages/Wuzzy/mineclone2/shields/downloads/" alt="ContentDB"></a> <a href="https://www.gnu.org/copyleft/gpl.html"><img src="https://img.shields.io/badge/License-GPLv3+-blue.svg" alt="GPLv3+ License"></a>
|
||||
|
||||
### Gameplay
|
||||
You start in a randomly-generated world made entirely of cubes. You can explore
|
||||
the world and dig and build almost every block in the world to create new
|
||||
structures. You can choose to play in a “survival mode” in which you have to
|
||||
fight monsters and hunger for survival and slowly progress through the
|
||||
various other aspects of the game, such as mining, farming, building machines, and so on
|
||||
Or you can play in “creative mode” in which you can build almost anything instantly.
|
||||
<p>A survival sandbox game for Luanti. Survive, gather, hunt, mine for ores,
|
||||
build, explore, and do much more. Inspired by Minecraft, pushing beyond.</p>
|
||||
|
||||
#### Gameplay summary
|
||||
<p>Originally forked from MineClone (by davedevils) as MineClone 2, then renamed
|
||||
and heavily improved. Developed by many people, see
|
||||
<a href="CREDITS.md"><code>CREDITS.md</code></a> for a complete list.</p>
|
||||
</div>
|
||||
|
||||
* Sandbox-style gameplay, no goals
|
||||
* Survive: Fight against hostile monsters and hunger
|
||||
* Mine for ores and other treasures
|
||||
* Magic: Gain experience and enchant your tools
|
||||
* Use the collected blocks to create great buildings, your imagination is the limit
|
||||
* Collect flowers (and other dye sources) and colorize your world
|
||||
* Find some seeds and start farming
|
||||
* Find or craft one of hundreds of items
|
||||
* Build a railway system and have fun with minecarts
|
||||
* Build complex machines with redstone circuits
|
||||
* In creative mode you can build almost anything for free and without limits
|
||||
|
||||
## How to play (quick start)
|
||||
### Getting started
|
||||
* **Punch a tree** trunk until it breaks and collect wood
|
||||
* Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu) and craft 4 wood planks
|
||||
* Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a crafting table**
|
||||
* **Rightclick the crafting table** for a 3×3 crafting grid to craft more complex things
|
||||
* Use the **crafting guide** (book icon) to learn all the possible crafting recipes
|
||||
* **Craft a wooden pickaxe** so you can dig stone
|
||||
* Different tools break different kinds of blocks. Try them out!
|
||||
* Continue playing as you wish. Have fun!
|
||||
## About
|
||||
|
||||
### Farming
|
||||
* Find seeds
|
||||
* Craft a hoe
|
||||
* Rightclick dirt or a similar block with a hoe to create farmland
|
||||
* Place seeds on farmland and watch them grow
|
||||
* Collect plants when fully grown
|
||||
* If near water, farmland becomes wet and speeds up growth
|
||||
You start in a randomly generated world made entirely of cubes. You can explore
|
||||
the world, dig, and build using almost every available block to create new
|
||||
structures. You can choose to play in **survival mode**, in which you must fight
|
||||
monsters and stave off hunger while slowly progressing through various aspects
|
||||
of the game—such as mining, farming, and building machines. Alternatively, you
|
||||
can opt for **creative mode**, where you can do anything you can imagine with a
|
||||
snap of your fingers.
|
||||
|
||||
### Furnace
|
||||
* Craft a furnace
|
||||
* The furnace allows you to obtain more items
|
||||
* Upper slot must contain a smeltable item (example: iron ore)
|
||||
* Lower slot must contain a fuel item (example: coal)
|
||||
* See tooltips in crafting guide to learn about fuels and smeltable items
|
||||
See [`GETTING_STARTED.md`](GETTING_STARTED.md) for a quick guide on how to start
|
||||
playing VoxeLibre.
|
||||
|
||||
### Additional help
|
||||
More help about the gameplay, blocks items and much more can be found from inside
|
||||
the game. You can access the help from your inventory menu.
|
||||
### Gameplay summary
|
||||
|
||||
### Special items
|
||||
The following items are interesting for Creative Mode and for adventure
|
||||
map builders. They can not be obtained in-game or in the creative inventory.
|
||||
* **Sandbox-style gameplay with no set goals**
|
||||
* Survive by fighting hostile monsters and combating hunger
|
||||
* Mine for ores and hunt for underground treasures
|
||||
* Master magic by gaining experience and enchanting your tools
|
||||
* Gather blocks to build and unleash your imagination
|
||||
* Collect flowers and other dye sources to colorize your world
|
||||
* Find seeds and start farming for food and resources
|
||||
* Discover or craft hundreds of items
|
||||
* Have fun with minecarts by building a railroad or a rollercoaster
|
||||
* Construct complex machines using redstone circuits
|
||||
* Play in creative mode to create without limits
|
||||
|
||||
* Barrier: `mcl_core:barrier`
|
||||
### Notable features
|
||||
|
||||
Use the `/giveme` chat command to obtain them. See the in-game help for
|
||||
an explanation.
|
||||
A lot of the gameplay and features will be instantly familiar to the Minecraft
|
||||
players. VoxeLibre expands on top of those with lots of nice additions made by
|
||||
our many developers and contributors. Here are some highlights:
|
||||
|
||||
## Installation
|
||||
To run the game with the best performance and support, we recommend the latest
|
||||
stable version of [Luanti](https://www.luanti.org/), but we always make an effort
|
||||
to support one version behind the latest stable version. In some cases, older
|
||||
versions might still be good enough but you would be missing out on important
|
||||
Luanti features that enable important features for our game.
|
||||
* Awesome in-game and main menu music, toggleable using `/music`
|
||||
* Many additional decoration blocks, as well as stair and slab variants
|
||||
* Original tools and weapons, such as hammers and throwable spears
|
||||
* Consistent nice-looking artwork
|
||||
* Unique items, including the Hamburger to lure villagers
|
||||
* One-of-a-kind structures to explore
|
||||
* Nether portals of any enclosed shape (hearts, donuts, etc)
|
||||
* Signs with support for many languages
|
||||
* Advanced minecart physics with derailing and more
|
||||
* Great modding support making use of Luanti's powerful Lua scripting
|
||||
* Fun easter eggs to discover
|
||||
* **...and so much more!**
|
||||
|
||||
There is no support for running VoxeLibre in development versions of Luanti.
|
||||
|
||||
To install VoxeLibre (if you haven't already), move this directory into the
|
||||
“games” directory of your Luanti data directory. Consult the help of
|
||||
Luanti to learn more.
|
||||
|
||||
## Useful links
|
||||
The VoxeLibre repository is hosted at Mesehub. To contribute or report issues, head there.
|
||||
|
||||
The VoxeLibre Git repository is hosted at Mesehub. To contribute or report
|
||||
issues, head over there.
|
||||
|
||||
* Mesehub: <https://git.minetest.land/VoxeLibre/VoxeLibre>
|
||||
* Discord: <https://discord.gg/xE4z8EEpDC>
|
||||
* YouTube: <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* ContentDB: <https://content.luanti.org/packages/wuzzy/mineclone2/>
|
||||
* OpenCollective: <https://opencollective.com/voxelibre>
|
||||
* Luanti Forums: <https://forum.luanti.org/viewtopic.php?f=50&t=16407>
|
||||
* Discord: <https://discord.gg/xE4z8EEpDC>
|
||||
* Matrix space: <https://app.element.io/#/room/#voxelibre:matrix.org>
|
||||
* Mastodon: <https://fosstodon.org/@VoxeLibre>
|
||||
* Lemmy: <https://lemm.ee/c/voxelibre>
|
||||
* Matrix space: <https://app.element.io/#/room/#voxelibre:matrix.org>
|
||||
* Luanti forums: <https://forum.luanti.org/viewtopic.php?f=50&t=16407>
|
||||
* Reddit: <https://www.reddit.com/r/VoxeLibre/>
|
||||
* IRC (barely used): <https://web.libera.chat/#mineclone2>
|
||||
* YouTube: <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* OpenCollective: <https://opencollective.com/voxelibre>
|
||||
|
||||
## Target
|
||||
- Create a stable, peformant, moddable, free/libre game inspired by Minecraft
|
||||
using the Luanti engine, usable in both singleplayer and multiplayer.
|
||||
- Currently, a lot of features are already implemented.
|
||||
Polishing existing features is always welcome.
|
||||
|
||||
## Completion status
|
||||
This game is currently in **beta** stage.
|
||||
It is playable, but not yet feature-complete.
|
||||
Backwards-compability is not entirely guaranteed, updating your world might cause small bugs.
|
||||
If you want to use the development version of VoxeLibre in production, the master branch is usually relatively stable.
|
||||
## Status
|
||||
|
||||
The following main features are available:
|
||||
VoxeLibre is currently in the **beta** stage. It is fully playable, but not yet
|
||||
feature-complete, and you may encounter bugs while playing. Backwards
|
||||
compatibility is not entirely guaranteed, and upgrading your world might cause
|
||||
small bugs. If you want to, you can use the development version (the `master`
|
||||
Git branch) to get the newest content and help us catch bugs before release.
|
||||
|
||||
* Tools, weapons
|
||||
* Armor
|
||||
* Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide
|
||||
* Chests, large chests, ender chests, shulker boxes
|
||||
* Furnaces, hoppers
|
||||
* Hunger
|
||||
* Most monsters and animals
|
||||
* All ores from Minecraft
|
||||
* Most blocks in the overworld
|
||||
* Water and lava
|
||||
* Weather
|
||||
* 28 biomes + 5 Nether Biomes
|
||||
* The Nether, a fiery underworld in another dimension
|
||||
* Redstone circuits (partially)
|
||||
* Minecarts (partial)
|
||||
* Status effects (partial)
|
||||
* Experience
|
||||
* Enchanting
|
||||
* Brewing, potions, tipped arrow (partial)
|
||||
* Boats
|
||||
* Fire
|
||||
* Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
|
||||
* Clock
|
||||
* Compass
|
||||
* Sponge
|
||||
* Slime block
|
||||
* Small plants and saplings
|
||||
* Dyes
|
||||
* Banners
|
||||
* Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
|
||||
* Item frames
|
||||
* Jukeboxes
|
||||
* Beds
|
||||
* Inventory menu
|
||||
* Creative inventory
|
||||
* Farming
|
||||
* Writable books
|
||||
* Commands
|
||||
* Villages
|
||||
* The End
|
||||
* And more!
|
||||
### Goals
|
||||
|
||||
The following features are incomplete:
|
||||
* Create a stable, peformant, moddable and fun free & open-source game, making
|
||||
the most out of the Luanti engine, playable both in single- and multiplayer
|
||||
* Expand and improve upon the gameplay that many players are familiar with,
|
||||
adding unique features and polishing the existing ones along the way
|
||||
* Work on the tasks outlined in the [Milestones](/VoxeLibre/VoxeLibre/milestones)
|
||||
and themed [Projects](/VoxeLibre/VoxeLibre/projects) to make the game better
|
||||
* Ensure proper localization support, enabling translations in as many languages
|
||||
as possible
|
||||
* [Maintain a friendly and inclusive community of players and developers](CODE_OF_CONDUCT.md)
|
||||
|
||||
* Some monsters and animals
|
||||
* Redstone-related things
|
||||
* Some special minecarts (hopper and chest minecarts work)
|
||||
* A couple of non-trivial blocks and items
|
||||
|
||||
Bonus features (not found in Minecraft):
|
||||
## See also
|
||||
|
||||
* Built-in crafting guide which shows you crafting and smelting recipes
|
||||
* In-game help system containing extensive help about gameplay basics, blocks, items and more
|
||||
* Temporary crafting recipes. They only exist to make some otherwise unaccessible items available when you're not in creative mode. These recipes will be removed as development goes on an more features become available
|
||||
* Saplings in chests in [mapgen v6](https://wiki.luanti.org/Map_generator#v6)
|
||||
* Fully moddable (thanks to Luanti's powerful Lua API)
|
||||
* New blocks and items:
|
||||
* Lookup tool, shows you the help for whatever it touches
|
||||
* More slabs and stairs
|
||||
* Nether Brick Fence Gate
|
||||
* Red Nether Brick Fence
|
||||
* Red Nether Brick Fence Gate
|
||||
* Structure replacements - these small variants of Minecraft structures serve as replacements until we can get large structures working:
|
||||
* Woodland Cabin (Mansions)
|
||||
* Nether Outpost (Fortress)
|
||||
|
||||
Technical differences from Minecraft:
|
||||
|
||||
* Height limit of ca. 31000 blocks (much higher than in Minecraft)
|
||||
* Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large)
|
||||
* Still very incomplete and buggy
|
||||
* Blocks, items, enemies and other features are missing
|
||||
* A few items have slightly different names to make them easier to distinguish
|
||||
* Different music for jukebox
|
||||
* Different textures (Pixel Perfection)
|
||||
* Different sounds (various sources)
|
||||
* Different engine (Luanti)
|
||||
* Different easter eggs
|
||||
|
||||
… and finally, VoxeLibre is free software (“free” as in “freedom”)!
|
||||
|
||||
## Other readme files
|
||||
|
||||
* `LICENSE.txt`: The GPLv3 license text
|
||||
* `CONTRIBUTING.md`: Information for those who want to contribute
|
||||
* `API.md`: For Luanti modders who want to mod this game
|
||||
* `LEGAL.md`: Legal information
|
||||
* `CREDITS.md`: List of everyone who contributed
|
||||
* [`GETTING_STARTED.md`](GETTING_STARTED.md): Quick guide on how to start
|
||||
playing
|
||||
* [`CONTRIBUTING.md`](CONTRIBUTING.md): Information for those who want to contribute
|
||||
* [`API.md`](API.md): For people who want to mod VoxeLibre
|
||||
* [`LICENSE.txt`](LICENSE.txt): Full text of the GNU GPLv3 license
|
||||
* [`LEGAL.md`](LEGAL.md): Legal information
|
||||
* [`CREDITS.md`](CREDITS.md): List of all developers and contributors
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue