pandorabox-mods/readme.md

66 lines
1.1 KiB
Markdown
Raw Normal View History

2019-08-16 04:04:43 -07:00
# Pandorabox mods
2019-12-01 22:59:47 -08:00
![](https://github.com/pandorabox-io/pandorabox-mods/workflows/integration-test/badge.svg)
2019-08-28 04:31:02 -07:00
2019-08-16 04:04:43 -07:00
Pandorabox mod repo
## Install
After cloning:
2019-09-02 01:14:45 -07:00
```bash
2019-08-16 04:04:43 -07:00
git submodule init
git submodule update
```
2019-08-18 11:37:11 -07:00
2019-08-21 01:50:16 -07:00
## Updating
2019-09-02 01:14:45 -07:00
```bash
# sync repo urls
2019-08-21 01:50:16 -07:00
git submodule sync
2019-09-02 01:14:45 -07:00
# initialize new repos
2019-08-21 01:50:16 -07:00
git submodule init
2019-09-02 01:14:45 -07:00
# update commits
2019-08-21 01:50:16 -07:00
git submodule update
2019-09-02 01:14:45 -07:00
# remove unversioned files
git clean -dff
2019-08-21 01:50:16 -07:00
```
2019-09-02 23:38:40 -07:00
Or use the `update.sh` script in the root path
2019-08-18 11:37:11 -07:00
## Advisable settings
```
2019-08-18 18:55:52 -07:00
# allow protection
areas.self_protection = true
# lightweight node timer-based interrupts
mesecon.luacontroller_lightweight_interrupts = true
2019-08-18 11:37:11 -07:00
# don't let the unified inventory show *all* slopes/slabs (use the table saw for that)
moreblocks.stairsplus_in_creative_inventory = false
2019-08-24 08:00:05 -07:00
# enable bridger trusses
bridger_enable_trusses = true
2019-08-24 09:20:15 -07:00
# enable telemosaic rightclick teleport
telemosaic_right_click_teleport = true
2019-08-18 11:37:11 -07:00
```
2019-09-02 23:38:40 -07:00
## Optional mods
2019-09-03 00:01:33 -07:00
The following mods can be safely deleted in singleplayer:
2019-09-02 23:38:40 -07:00
```
monitoring
mesecons_debug
mail
mapserver
geoip
```
2019-09-09 05:46:39 -07:00
## Testing
The mod collection can be tested with the `test.sh` script.
prerequisite is a working docker setup