Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
jpanther committed Mar 25, 2019
2 parents 93568a7 + e94e3de commit 07caead
Show file tree
Hide file tree
Showing 23 changed files with 290 additions and 184 deletions.
29 changes: 29 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Contributing

Feel free to get in touch with any issues or suggestions for new features you'd like to see. I also welcome pull requests to fix bugs or implement new features. The best way to make contact is via [GitHub Issues](https://github.com/jpanther/Dectorio/issues).

### Did you find a bug?

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/jpanther/Dectorio/issues).
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/jpanther/Dectorio/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or a **test case** demonstrating the expected behaviour that is not occurring.

### Can you write a patch that fixes a bug or do you want to implement a new feature?

* Fork the `develop` branch.
> **Note:** The `master` branch is reserved for releases and is always in a 'production-ready' state. The `develop` branch is where the latest changes are developed and tested ahead of the next release.
* Create a new branch in your fork that describes the issue or new feature (i.e. `bugfix-nastybug` or `feature-mynewfeature`)

* Make the changes required to fix the bug or implement the new feature.

* Pull the upstream `develop` branch and merge it into your fork regularly to stay up to date with changes.

* When you're ready to submit your changes, and there are no conflicts with the upstream branch, push your fork and open a new GitHub pull request to the `develop` branch with your patch.

* Ensure the PR description clearly describes what the patch does. If it fixes a reported bug or feature request, include the relevant issue number.

### Credit

Contributors are automatically credited in the [CHANGELOG](changelog.txt) for any contributions made. If you would not like to be credited, please mention this in your pull request.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Report something that isn't working
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
Please provide a clear and concise description of what the bug is. If the game gives you an error message, include it here. Then complete any relevant sections below (and delete those that don't apply).

**How to reproduce**
Steps to reproduce the behaviour:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Mod list**
If you are playing with other mods, include a list of these mods. The best way to do this is to provide a copy of `mod-list.json` from your Factorio data folder.

**Multiplayer**
If playing in multiplayer and you experience a desync, please upload a copy of your desync report.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for the mod
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Eg. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you'd like to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Question
about: Ask a question about something else
title: ''
labels: question
assignees: ''

---

**What is your question?**
Be as detailed as possible.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/translation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Translation issue
about: Report a problem with the mod's translation into other languages
title: ''
labels: translation
assignees: ''

---

**If you'd like to add a new language for translation, please request it here**
Requests for new languages are welcome!

**All other translation issues should be reported on CrowdIn**
Dectorio uses CrowdIn to allow the community to translate the mod from English into various languages. If you are able to translate the mod into another language, please visit the [Dectorio project on CrowdIn](https://crowdin.com/project/dectorio) to help with the translation effort. You can suggest your own alternate translations if you find an issue, or vote for other user's suggestions.
29 changes: 29 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/build

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
74 changes: 16 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
# Dectorio
[![GitHub issues](https://img.shields.io/github/issues/jpanther/Dectorio.svg)](https://github.com/jpanther/Dectorio/issues) [![CrowdIn](https://d322cqt584bo4o.cloudfront.net/dectorio/localized.svg)](https://crowdin.com/project/dectorio) [![GitHub license](https://img.shields.io/github/license/jpanther/Dectorio.svg)](https://github.com/jpanther/Dectorio/blob/develop/LICENSE)

A simple mod that adds decorative elements to beautify your factory. New technology research is required to unlock the various items before they can be crafted and some default recipes are adjusted to better reflect how these items should be made.

Inspiration for the mod came from a lot of other mods on the Factorio mod portal, although all the assets in Dectorio have been custom made for this mod and are either modified versions of base game assets or created from scratch. If you'd like to use any of these in your own mod, please observe the GNU GPLv3 license.

Requires Factorio version 0.15 or later.

## How to install
⚠️ **Found a bug or want a new feature?** Report it on [GitHub](https://git.io/DectorioIssues).
🌏 **Can you help translate Dectorio?** Visit [CrowdIn](https://crowdin.com/project/dectorio) to get started.
⁉️ **Have a different question?** Visit the [FAQ](https://mods.factorio.com/mod/Dectorio/faq) for detailed information about common queries.

Download the latest stable release from the [Factorio mod portal](https://mods.factorio.com/mod/Dectorio) or at <https://github.com/jpanther/Dectorio/releases/latest> and copy the entire zip file to your Factorio mods directory:
# Dectorio

* Windows: `%appdata%\Factorio\mods`
* Mac: `~/Library/Application Support/factorio/mods/`
* Linux: `~/.factorio/mods`
Dectorio is a large mod that adds decorative elements to beautify your factory. New technology research is required to unlock the various items before they can be crafted and some default recipes are adjusted to better reflect how these items should be made.

> **Note:** If playing with Factorio 0.15, please download v0.7.6, or for Factorio 0.16, please download v0.8.11 as these are the last stable versions supported on these base game releases. v0.9.0 and later are only supported on Factorio 0.17.
Inspiration for the mod came from a lot of other mods on the portal, although all the assets in Dectorio have been custom made for this mod and are either modified versions of base game assets or created from scratch. If you'd like to use any of these in your own mod, please observe the GNU GPLv3 license.

When you launch the game, the new mod will be enabled by default.
Requires Factorio version 0.15 or later.

## Current Features
## Features

### Decorative items

Expand Down Expand Up @@ -98,41 +91,17 @@ Check out the [Mod Spotlight video by Xterminator](https://www.youtube.com/watch

🇩🇪 German players may be interested in this [Mod Monday video by SeeNo](https://www.youtube.com/watch?v=0SzAF997sOk).

## Frequently Asked Questions

Have a question that isn't covered here? Visit the [Dectorio FAQ](FAQ.md) to see if it's already been answered. If you still have a query, read below for details on how to raise an issue on GitHub.

## Development

### Contributing

Feel free to get in touch with any issues or suggestions for new features you'd like to see. I also welcome pull requests to fix bugs or implement new features. The best way to make contact is via [GitHub Issues](https://github.com/jpanther/Dectorio/issues).

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/jpanther/Dectorio/issues).
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
### Bugs & Suggestions

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/jpanther/Dectorio/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or a **test case** demonstrating the expected behaviour that is not occurring.
Feel free to get in touch with any issues or suggestions for new features you'd like to see. You can get in contact via the GitHub issues page at <https://git.io/DectorioIssues>. I'm also occasionally online on the Factorio Discord or Forums.

#### **Can you write a patch that fixes a bug or do you want to implement a new feature?**
### Community Translations

* Fork the `develop` branch.
> **Note:** The `master` branch is reserved for releases and is always in a 'production-ready' state. The `develop` branch is where the latest changes are developed and tested ahead of the next release.
Dectorio uses CrowdIn to allow the community to translate the mod from English into various languages. If you are able to translate the mod into another language, please visit the [Dectorio project on CrowdIn](https://crowdin.com/project/dectorio) to help with the translation effort. Requests for new languages are welcome!

* Create a new branch in your fork that describes the issue or new feature (i.e. `bugfix-nastybug` or `feature-mynewfeature`)

* Make the changes required to fix the bug or implement the new feature.

* Pull the upstream `develop` branch and merge it into your fork regularly to stay up to date with changes.

* When you're ready to submit your changes, and there are no conflicts with the upstream branch, push your fork and open a new GitHub pull request to the `develop` branch with your patch.

* Ensure the PR description clearly describes what the patch does. If it fixes a reported bug or feature request, include the relevant issue number.

### Language Support

Dectorio uses CrowdIn to translate the mod into various languages. Special thanks to all the translators listed below (in no particular order).
Special thanks to the translators below (in no particular order).

Fully supported languages:
* English
Expand All @@ -142,22 +111,20 @@ Community translations:
* Chinese Traditional (29%)
* Czech (64%) - [dereksp](https://crowdin.com/profile/dereksp) and [Meritic](https://crowdin.com/profile/Meritic).
* French (87%) - [Taniotoshi](https://crowdin.com/profile/Taniotoshi).
* German (94%) - [seeba8](https://github.com/seeba8), [ST-DDT](https://crowdin.com/profile/ST-DDT) and [LastDawn](https://crowdin.com/profile/LastDawn).
* German (100%) - [seeba8](https://github.com/seeba8), [ST-DDT](https://crowdin.com/profile/ST-DDT), [LastDawn](https://crowdin.com/profile/LastDawn) and [lpzockerx](https://crowdin.com/profile/lpzockerx).
* Korean (87%) - [Xagros](https://crowdin.com/profile/GimoXagros).
* Polish (54%) - [Tomirad](https://github.com/Tomirad).
* Portuguese, Brazilian (100%) - [celaquila](https://crowdin.com/profile/celaquila).
* Russian (94%) - [nastyslave](https://crowdin.com/profile/nastyslave), [diraria](https://crowdin.com/profile/diraria), [scheugen86](https://crowdin.com/profile/scheugen86), [antonus777](https://crowdin.com/profile/antonus777) and [schmarotzerltd](https://crowdin.com/profile/schmarotzerltd).
* Spanish (96%) - [notallme](https://crowdin.com/profile/notallme).

If you are able to translate the mod into any of the above languages, or you know an additional language that you'd like to add a new translation for, please visit the [Dectorio project on CrowdIn](https://crowdin.com/project/dectorio) to help with the translation effort.
* Spanish (100%) - [notallme](https://crowdin.com/profile/notallme).

### Mod Compatibility

**Note:** If playing with Factorio 0.15, please download v0.7.6, or for Factorio 0.16, please download v0.8.11 as these are the last stable versions supported on these base game releases. v0.9.0 and later are only supported on Factorio 0.17.

Limited testing has been completed with other mods. Warnings will be shown in-game to highlight any known issues. If you come across a specific compatibility issue, please let me know and I'll see what I can do to fix it.

It is not recommended to use other coloured signal mods at the same time as Dectorio. This can cause coloured signals to be overwritten multiple times and lead to game-breaking compatibility issues with other mods. If you would like more colours, you can add these in the Dectorio config.lua file (instructions are in the file).
It is not recommended to use other coloured signal mods at the same time as Dectorio. This can cause coloured signals to be overwritten multiple times and lead to game-breaking compatibility issues with other mods. If you would like more colours, you can add these in the Dectorio config.lua file (instructions are in the file). For full details, visit the [FAQ](https://mods.factorio.com/mod/Dectorio/faq).

Dectorio includes specific support for [Alien Biomes](https://mods.factorio.com/mod/alien-biomes).

Expand All @@ -166,12 +133,3 @@ Other mods with additional Dectorio support (thanks!): [Concreep](https://mods.f
Other decorative mods worth checking out (all compatible with Dectorio): [Asphalt Roads](https://mods.factorio.com/mod/AsphaltRoads), [Beautiful Bridge Railway](https://mods.factorio.com/mod/beautiful_bridge_railway), [Color Coding](https://mods.factorio.com/mod/color-coding), [Naked Rails](https://mods.factorio.com/mod/naked-rails), [Reinforced Walls](https://mods.factorio.com/mod/Reinforced-Walls).

Mods with known compatibility issues with Dectorio (either don't install these, or edit your mod settings and disable the conflicting components in Dectorio): [Expanded Color Lamps](https://mods.factorio.com/mod/Expanded_Color_Lamps).

### Changelog

Refer to the [CHANGELOG](changelog.txt) for a detailed list of changes in each version. The changelog is also available in-game from the _Mods_ screen.

### Credits

Developed with ❤ by [James Panther](https://github.com/jpanther) in Melbourne, Australia.
Special thanks to [marcfj](https://github.com/marcfj) for support and play testing.
8 changes: 8 additions & 0 deletions changelog.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
---------------------------------------------------------------------------------------------------
Version: 0.9.9
Date: 25. 03. 2019
Changed:
- Added support for new pollution model introduced in 0.17.12
Locales:
- Updated German translation (thanks to lpzockerx and LastDawn)
- Updated Spanish translation (thanks to notallme)
---------------------------------------------------------------------------------------------------
Version: 0.9.8
Date: 19. 03. 2019
Added:
Expand Down
5 changes: 5 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
files:
- source: /locale/en/
translation: /locale/%two_letters_code%/dectorio.cfg
type: ini
dest: /dectorio.ini
4 changes: 2 additions & 2 deletions info.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "Dectorio",
"version": "0.9.8",
"version": "0.9.9",
"title": "Dectorio",
"author": "PantherX",
"contact": "",
"homepage": "https://github.com/jpanther/Dectorio",
"factorio_version": "0.17",
"dependencies": ["base >= 0.17.10", "? alien-biomes >= 0.4.1", "(?) Expanded_Color_Lamps < 0.1"],
"dependencies": ["base >= 0.17.12", "? alien-biomes >= 0.4.1", "(?) Expanded_Color_Lamps < 0.1"],
"license": "GNU GPLv3"
}
4 changes: 0 additions & 4 deletions locale/cs/dectorio.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,6 @@ dect-paint-defect-right=Poruchový beton
dect-paint-operations-left=Operační beton
dect-paint-operations-right=Operační beton
dect-wood-floor=Dřevěné parkety
dect-stone-gravel=Kamený šterk
dect-iron-ore-gravel=Kovový šterk
dect-copper-ore-gravel=Měděný štěrk
dect-coal-gravel=Uhelný štěrk

[technology-name]
Expand All @@ -137,7 +134,6 @@ stone-walls=Základní zdi
dect-advanced-walls=Pokročilé zdi
dect-wood-floor=Dřevěné parkety
landfill=Zemní práce
dect-lawnmower=Sekačka
dect-signs=Cedule

[technology-description]
Expand Down
Loading

0 comments on commit 07caead

Please sign in to comment.