DimDoors/docs/README.md

45 lines
3.4 KiB
Markdown
Raw Normal View History

2017-04-02 02:19:16 +02:00
# Dimensional Doors
2020-10-27 15:25:10 +01:00
[![CF Dl Count](http://cf.way2muchnoise.eu/full_dimensionaldoors_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/dimensionaldoors)
[![MC Versions](http://cf.way2muchnoise.eu/versions/Minecraft_dimensionaldoors_all.svg)](https://www.curseforge.com/minecraft/mc-mods/dimensionaldoors)
2021-04-16 05:16:27 +02:00
[![Last Commit](https://img.shields.io/github/last-commit/DimensionalDevelopment/DimDoors.svg)](https://github.com/DimensionalDevelopment/DimDoors/commits/1.17)
2017-04-02 01:52:20 +02:00
## Overview
2021-04-16 05:16:27 +02:00
This is the main repository for the rewrite of Dimensional Doors by StevenRS11. This repository contains the up-to-date code base and commits submitted.
**This mod is for fabric**
**For a Forge Version, check [here](https://www.youtube.com/watch?v=dQw4w9WgXcQ)**
## Discord Server
For the main bits, we have a Discord server made specifically for talking about Dimensional Doors. It's also the place where the devs meet to discuss current progress on certain aspects, and get feedback from the team.
### Discord Server: [Click](https://discord.gg/f27hdrM) to open in browser or client, if installed
2017-04-02 01:52:20 +02:00
## Bugs and Suggestions
Experiencing a bug or just have a suggestion that is in-line with the mod's lore? Make a ticket about it!
### Bug Reports
You can report any bugs you find on [the issues page](https://github.com/DimensionalDevelopment/DimDoors/issues). Please include the following information:
- The version of the mod you're using
- Your Minecraft version (different versions can experience bugs that are not available in others)
- A list of other mods you're using, if the issue does not happen with only Dimensional Doors installed
- A crash report, or preferably a full log (latest.log and debug.log).
### Suggestions
For suggestions, please join [our discord server](https://discord.gg/f27hdrM), or [create a Github issue](https://github.com/DimensionalDevelopment/DimDoors/issues). Please include a detailed description with what you would like to see in the mod and explain how it can fit into the mod's lore.
## Contributing
There are many ways to contribute to the project. We encourage you to join our Discord server if you have any questions about how to contribute.
### Submitting dungeons
Check [https://youtu.be/Qvp2EnctKIQ](https://youtu.be/Qvp2EnctKIQ) for instructions. Save it using WorldEdit and send the dungeon in our discord server.
### Translating
[This page](https://github.com/DimensionalDevelopment/DimDoors/tree/1.12-WIP/src/main/resources/assets/dimdoors/lang) contains all the currently translated languages. To contribute a translation, start by copying the [en_US.lang file](https://github.com/DimensionalDevelopment/DimDoors/blob/1.12-WIP/src/main/resources/assets/dimdoors/lang/en_US.lang) to a text editor, and saving it as the [correct locale code](https://minecraft.gamepedia.com/Language#Available_languages). Translate **only what is to the right of the = sign**, and then click "Create a new file" on [this page](https://github.com/DimensionalDevelopment/DimDoors/tree/1.12-WIP/src/main/resources/assets/dimdoors/lang) to submit your translation.
2017-04-02 01:52:20 +02:00
## Join the Team
Dimensional Development is always looking to expand (there are currently only 3 active members in the team) and introduce new members to the team and community. Join our Discord and talk to us! Tell us how you can help.
## Tutorials
- [Types of Virtual Targets](tutorials/virtual_targets/virtual_targets.md)
- [Types of Pocket Modifiers](tutorials/modifiers/modifiers.md)