Browse Source

still more formatting

master
poikilos 9 years ago
committed by Jacob Gustafson
parent
commit
44ac248743
  1. 103
      README.md

103
README.md

@ -19,29 +19,29 @@ This program comes without any warranty, to the extent permitted by applicable l
* to maintain stability of your text editor, save the file, close it, then move/copy it to the directory (or save it as something else then rename it to signals.txt). * to maintain stability of your text editor, save the file, close it, then move/copy it to the directory (or save it as something else then rename it to signals.txt).
* alternatively, in GNU/Linux systems do something like: * alternatively, in GNU/Linux systems do something like:
<code> ```
echo "refresh_map_enable:False" > $HOME/chunkymap/signals.txt echo "refresh_map_enable:False" > $HOME/chunkymap/signals.txt
sleep 15s sleep 15s
echo "loop_enable:False" > $HOME/chunkymap/signals.txt echo "loop_enable:False" > $HOME/chunkymap/signals.txt
</code> ```
* list of signals: * list of signals:
<code> ```
loop_enable:True loop_enable:True
loop_enable:False loop_enable:False
#verbose_enable is false for looped (default) mode and true for non-looped mode #verbose_enable is false for looped (default) mode and true for non-looped mode
verbose_enable:True verbose_enable:True
verbose_enable:False verbose_enable:False
refresh_players_enable:True refresh_players_enable:True
refresh_players_enable:False refresh_players_enable:False
refresh_map_enable:True refresh_map_enable:True
refresh_map_enable:False refresh_map_enable:False
#rerenders chunks that were rendered in this run: #rerenders chunks that were rendered in this run:
recheck_rendered:True recheck_rendered:True
#where 1 is number of seconds (only delays first iteration--further iterations continue until refreshing player is needed): #where 1 is number of seconds (only delays first iteration--further iterations continue until refreshing player is needed):
refresh_map_seconds:1 refresh_map_seconds:1
#where 1 is number of seconds: #where 1 is number of seconds:
refresh_players_seconds:1 refresh_players_seconds:1
</code> ```
* Save jpg or png named as player's index to the players folder of the world to change player's icon on map (index is a number assigned for use with ajax when $show_player_names_enable is false). The index can be found in the player's yml file generated by chunkymap-regen.py. * Save jpg or png named as player's index to the players folder of the world to change player's icon on map (index is a number assigned for use with ajax when $show_player_names_enable is false). The index can be found in the player's yml file generated by chunkymap-regen.py.
* Can show a static html version of map (echo_chunkymap_table() php function) -- see viewchunkymap.php * Can show a static html version of map (echo_chunkymap_table() php function) -- see viewchunkymap.php
@ -60,7 +60,7 @@ This should be hard to corrupt since id is used as the indexer for the players d
* games_path, mods_path, players_path, and other subdirectories of the major ones should not be stored in minetestmeta.yml, since otherwise the values may deviate from the parent directories when the parent directories change. * games_path, mods_path, players_path, and other subdirectories of the major ones should not be stored in minetestmeta.yml, since otherwise the values may deviate from the parent directories when the parent directories change.
To avoid this problem, instead derive the paths from the parent paths using your favorite language such as in the following examples: To avoid this problem, instead derive the paths from the parent paths using your favorite language such as in the following examples:
` ```
games_path = os.path.join(minetestinfo.get_var("shared_minetest_path"), "games") games_path = os.path.join(minetestinfo.get_var("shared_minetest_path"), "games")
mods_path = os.path.join(minetestinfo.get_var("game_path"), "mods") mods_path = os.path.join(minetestinfo.get_var("game_path"), "mods")
players_path = os.path.join(minetestinfo.get_var("primary_world_path"), "players") players_path = os.path.join(minetestinfo.get_var("primary_world_path"), "players")
@ -69,18 +69,18 @@ To avoid this problem, instead derive the paths from the parent paths using your
if minetestinfo.contains("primary_world_path"): if minetestinfo.contains("primary_world_path"):
world_path = minetestinfo.get_var("primary_world_path") world_path = minetestinfo.get_var("primary_world_path")
world_name = os.path.basename(world_path) world_name = os.path.basename(world_path)
` ```
* Keep in mind that gameid (in game.conf in a subgame folder, and world.mt in a world folder) is NOT case-sensitive: for example, minetest_game has the gameid 'Minetest' (first letter capitalized) but the worlds generated by Minetest client have the gameid 'minetest' (lowercase) in their world.mt * Keep in mind that gameid (in game.conf in a subgame folder, and world.mt in a world folder) is NOT case-sensitive: for example, minetest_game has the gameid 'Minetest' (first letter capitalized) but the worlds generated by Minetest client have the gameid 'minetest' (lowercase) in their world.mt
Yet somehow for everything else, gameid in world.mt is the name of the game FOLDER (NOT the name variable in the folder's game.conf) Yet somehow for everything else, gameid in world.mt is the name of the game FOLDER (NOT the name variable in the folder's game.conf)
* the map update function is only able to detect new chunks, and only checks edge chunks if player is present in one * the map update function is only able to detect new chunks, and only checks edge chunks if player is present in one
* The following are saved to chunkymap.yml (and confirmed interactively if not already set): * The following are saved to chunkymap.yml (and confirmed interactively if not already set):
` ```
www_minetest_path (such as /var/www/html/minetest) www_minetest_path (such as /var/www/html/minetest)
user_minetest_path user_minetest_path
world_name world_name
world_path world_path
` ```
## Requirements: ## Requirements:
* A minetest version compatible with minetestmapper-numpy.py Made by Jogge, modified by celeron55 * A minetest version compatible with minetestmapper-numpy.py Made by Jogge, modified by celeron55
@ -93,7 +93,7 @@ world_path
* If you are using Ubuntu * If you are using Ubuntu
* Install the git version of minetest (or otherwise install 0.4.13 or other version compatible with the map generators used by chunkymap) * Install the git version of minetest (or otherwise install 0.4.13 or other version compatible with the map generators used by chunkymap)
such as: such as:
` ```
#if you have a version before 2016-03-23: #if you have a version before 2016-03-23:
rm rename-deprecated.sh rm rename-deprecated.sh
wget https://github.com/expertmm/minetest-chunkymap/raw/master/rename-deprecated.sh wget https://github.com/expertmm/minetest-chunkymap/raw/master/rename-deprecated.sh
@ -110,25 +110,28 @@ world_path
#./update-chunkymap-on-ubuntu-from-web.sh #./update-chunkymap-on-ubuntu-from-web.sh
sudo python chunkymap/singleimage.py sudo python chunkymap/singleimage.py
sudo python chunkymap/generator.py sudo python chunkymap/generator.py
` ```
OPTION 2: IF you are using Ubuntu go to a terminal, cd to this directory, OPTION 2: IF you are using Ubuntu go to a terminal, cd to this directory,
then switch user to the one that will run minetestserver then switch user to the one that will run minetestserver
(since install-chunkymap-on-ubuntu.sh DOES replace "/home/owner" with current user's home [replace-with-current-user.py, which is automatically called by install, will change /home/owner to current user's directory in each script that install copies to $HOME/chunkymap]) (since install-chunkymap-on-ubuntu.sh DOES replace "/home/owner" with current user's home [replace-with-current-user.py, which is automatically called by install, will change /home/owner to current user's directory in each script that install copies to $HOME/chunkymap])
then go to Terminal and run: then go to Terminal and run:
```
`minetestserver` minetestserver
```
then when it is finished loading, press Ctrl C then run: then when it is finished loading, press Ctrl C then run:
```
`chmod +x install-chunkymap-on-ubuntu.sh && ./install-chunkymap-on-ubuntu.sh` chmod +x install-chunkymap-on-ubuntu.sh && ./install-chunkymap-on-ubuntu.sh
```
Installing as cron job is OPTIONAL (and NOT recommended): Installing as cron job is OPTIONAL (and NOT recommended):
* IF you are using a distro such as Ubuntu 14.04 where first line of /etc/crontab is "m h dom mon dow user command" then if you want regular refresh of map then run: * IF you are using a distro such as Ubuntu 14.04 where first line of /etc/crontab is "m h dom mon dow user command" then if you want regular refresh of map then run:
(otherwise first edit the script to fit your crontab then) (otherwise first edit the script to fit your crontab then)
(if you are not using /var/www/html/minetest/chunkymapdata, edit chunkymap-cronjob script to use the correct directory, then) (if you are not using /var/www/html/minetest/chunkymapdata, edit chunkymap-cronjob script to use the correct directory, then)
`chmod +x set-minutely-crontab-job.sh && ./set-minutely-crontab-job.sh` ```
chmod +x set-minutely-crontab-job.sh && ./set-minutely-crontab-job.sh
```
* IF you are using Linux * IF you are using Linux
* Rename viewchunkymap.php so it won't be overwritten on update if you want to modify it (or anything you want) then make a link to it on your website or share the link some other way. * Rename viewchunkymap.php so it won't be overwritten on update if you want to modify it (or anything you want) then make a link to it on your website or share the link some other way.
` ```
# The commands below will work if you are using the web installer, or have done mv minetest-chunkymap-master "$HOME/Downloads/minetest-chunkymap" (and if you are using /var/www/html/minetest -- otherwise change that below) # The commands below will work if you are using the web installer, or have done mv minetest-chunkymap-master "$HOME/Downloads/minetest-chunkymap" (and if you are using /var/www/html/minetest -- otherwise change that below)
MT_MY_WEBSITE_PATH=/var/www/html/minetest MT_MY_WEBSITE_PATH=/var/www/html/minetest
sudo cp -f "$HOME/Downloads/minetest-chunkymap/web/chunkymap.php" "$MT_MY_WEBSITE_PATH/chunkymap.php" sudo cp -f "$HOME/Downloads/minetest-chunkymap/web/chunkymap.php" "$MT_MY_WEBSITE_PATH/chunkymap.php"
@ -136,7 +139,7 @@ world_path
sudo cp -R --no-clobber "$HOME/Downloads/minetest-chunkymap/web/images/*" "$MT_MY_WEBSITE_PATH/images/" sudo cp -R --no-clobber "$HOME/Downloads/minetest-chunkymap/web/images/*" "$MT_MY_WEBSITE_PATH/images/"
#--no-clobber: do not overwrite existing #--no-clobber: do not overwrite existing
# after you do this, the update script will do it for you if you are using /var/www/html/minetest, otherwise edit the update script before using it to get these things updated # after you do this, the update script will do it for you if you are using /var/www/html/minetest, otherwise edit the update script before using it to get these things updated
` ```
* IF you are using Windows * IF you are using Windows
* Install Python 2.7 * Install Python 2.7
* Run install-chunkymap-on-windows.bat * Run install-chunkymap-on-windows.bat
@ -147,25 +150,30 @@ world_path
* python 2.7.x such as from python.org * python 2.7.x such as from python.org
* run get_python_architecture.py to make sure you know whether to download the following in 32-bit or 64-bit * run get_python_architecture.py to make sure you know whether to download the following in 32-bit or 64-bit
Administrator Command Prompt (to find it in Win 10, right-click windows menu) Administrator Command Prompt (to find it in Win 10, right-click windows menu)
* update python package system: * update python package system:
`C:\python27\python -m pip install --upgrade pip wheel setuptools` ```
C:\python27\python -m pip install --upgrade pip wheel setuptools
```
* numpy such as can be installed via the easy unofficial installer wheel at * numpy such as can be installed via the easy unofficial installer wheel at
http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy
then: then:
```
`#cd to the folder where you downloaded the whl file ` #cd to the folder where you downloaded the whl file
`C:\python27\python -m pip install "numpy-1.10.4+mkl-cp27-cp27m-win32.whl"` C:\python27\python -m pip install "numpy-1.10.4+mkl-cp27-cp27m-win32.whl"
```
(but put your specific downloaded whl file instead) (but put your specific downloaded whl file instead)
* Pillow (instead of PIL (Python Imaging Library) which is a pain on Windows): there is a PIL installer wheel for Python such as 2.7 here: * Pillow (instead of PIL (Python Imaging Library) which is a pain on Windows): there is a PIL installer wheel for Python such as 2.7 here:
http://www.lfd.uci.edu/~gohlke/pythonlibs/ http://www.lfd.uci.edu/~gohlke/pythonlibs/
as suggested on http://stackoverflow.com/questions/2088304/installing-pil-python-imaging-library-in-win7-64-bits-python-2-6-4 as suggested on http://stackoverflow.com/questions/2088304/installing-pil-python-imaging-library-in-win7-64-bits-python-2-6-4
then: then:
```
`C:\python27\python -m pip install "Pillow-3.1.1-cp27-none-win32.whl"` C:\python27\python -m pip install "Pillow-3.1.1-cp27-none-win32.whl"
```
(but put your specific downloaded whl file instead, such as Pillow-3.1.1-cp27-none-win_amd64.whl) (but put your specific downloaded whl file instead, such as Pillow-3.1.1-cp27-none-win_amd64.whl)
* run (or if your python executable does not reside in C:\Python27\ then first edit the file): * run (or if your python executable does not reside in C:\Python27\ then first edit the file):
```
`chunkymap-regen-loop.bat` chunkymap-regen-loop.bat
```
(all the batch does is run C:\Python27\python chunkymap-regen.py) (all the batch does is run C:\Python27\python chunkymap-regen.py)
(chunkymap-regen.py will ask for configuration options on first run and ask for your www root) (chunkymap-regen.py will ask for configuration options on first run and ask for your www root)
@ -174,8 +182,9 @@ world_path
* Fix chunk generation and draw decachunks to canvas (so singleimage.py is not required to be run before chunkymap-regen.py) * Fix chunk generation and draw decachunks to canvas (so singleimage.py is not required to be run before chunkymap-regen.py)
* Detect exceptions in mintestmapper (such as database locked) and do NOT mark the chunk as is_empty * Detect exceptions in mintestmapper (such as database locked) and do NOT mark the chunk as is_empty
* Move the following to config dict: * Move the following to config dict:
```
`python_exe_path` python_exe_path
```
* chunkymap.php should read the size of the chunks -- see near is_file($chunk_genresult_path) in chunkymap.php * chunkymap.php should read the size of the chunks -- see near is_file($chunk_genresult_path) in chunkymap.php
* optionally hide player location * optionally hide player location
* Make a method (in chunkymap.php) to echo the map as an html5 canvas (refresh players every 10 seconds, check for new map chunks every minute) * Make a method (in chunkymap.php) to echo the map as an html5 canvas (refresh players every 10 seconds, check for new map chunks every minute)

Loading…
Cancel
Save