https://github.com/rubenwardy/minetest_modding_book
MIGRATED TO GITLAB: https://gitlab.com/rubenwardy/minetest_modding_book
https://github.com/rubenwardy/minetest_modding_book
book minetest modding tutorial
Last synced: 8 days ago
JSON representation
MIGRATED TO GITLAB: https://gitlab.com/rubenwardy/minetest_modding_book
- Host: GitHub
- URL: https://github.com/rubenwardy/minetest_modding_book
- Owner: rubenwardy
- Created: 2014-12-11T08:46:13.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T23:44:46.000Z (9 months ago)
- Last Synced: 2025-03-27T01:47:44.463Z (26 days ago)
- Topics: book, minetest, modding, tutorial
- Language: SCSS
- Homepage: https://rubenwardy.com/minetest_modding_book
- Size: 3.32 MB
- Stars: 63
- Watchers: 10
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minetest Modding Book
[](https://gitlab.com/rubenwardy/minetest_modding_book/pipelines)
[Read Online](https://rubenwardy.com/minetest_modding_book/)
Book written by rubenwardy.
License: CC-BY-SA 3.0
## Finding your way around
* `_data/` - Contains list of languages
* `_layouts/` - Layouts to wrap around each page.
* `static/` - CSS, images, scripts.
* `_/`
* `/` - Markdown files for each chapter.
## Contributing chapters
* Create a pull request with a new chapter in markdown.
* Write a new chapter in the text editor of your choice and
[send them to me](https://rubenwardy.com/contact/).
I'm happy to fix the formatting of any chapters. It is
the writing which is the hard bit, not the formatting.
### Chapter and Writing Guide
Grammar and such:
* British English, except when referring common code words like `color` and
`initialize`.
* Prefer pronounless text, but `you` if you must. Never `we` nor `I`.
* Titles and subheadings should be in Title Case.
* References to code (such as function names) should be formatted as \`inline-code`.
* Italics used for emphasis, not necessarily for technical words.
* Full stops and correct punctionation, except for lists without full sentences.
Formatting:
* Do not rely on anything that isn't printable to a physical book.
* Any links must be invisible - ie: if they're removed, then the chapter must
still make sense.
* Table of contents for each chapter with anchor links.
* Add `your turn`s to the end of a chapter when relevant.
### Making a Chapter
To create a new chapter, make a new file in _en/section/.
Name it something that explains what the chapter is about.
Replace spaces with underscores ( _ )
```markdown
---
title: Chapter Name
layout: default
root: ..
idx: 4.5
long_notice:
level: tip
title: This is a long tip!
message: This is a very long tip, so it would be unreadable if
placed in the main body of the chapter. Therefore,
it is a good idea to put it in the frontmatter instead.
---
## Chapter Name
Write a paragraph or so explaining what will be covered in this chapter.
Explain why/how these concepts are useful in modding
* [List the](#list-the)
* [Parts in](#parts-in)
* [This Chapter](#this-chapter)
## List the
{% include notice.html notice=page.long_notice %}
Paragraphs
\```lua
code
\```
## Parts in
## This Chapter
```
## Commits
If you are editing or creating a particular chapter, then use commit messages like this:
```
Getting Started - corrected typos
Entities - created chapter
```
Just use a normal style commit message otherwise.
## Adding a new language
1. Copy `_en/` to your language code
2. Add entry to `_data/languages.yml`
3. Add entry to `collections` in `_config.yml`
4. Add your language to the if else in `layouts/default.html`
5. Translate your language code folder (that you made in step 1)
You can translate the file paths, just make sure you keep any ids the same.
## Using Jeykll
I use [Jekyll](http://jekyllrb.com/) 3.8.0
# For Debian/Ubuntu based:
sudo apt install ruby-dev
gem install jekyll github-pages
### Building as a website
You can build it as a website using [Jekyll](http://jekyllrb.com/)
$ jekyll build
Goes to _site/
### Webserver for Development
You can start a webserver on localhost which will automatically
rebuild pages when you modify their markdown source.
$ jekyll serve
This serves at on my computer, but the port
may be different. Check the console for the "server address"