Skip to content

Commit

Permalink
- Update README with links to help for programs and file types
Browse files Browse the repository at this point in the history
- Add requirements.txt to make pip installation easier
- Update installation instructions in README a bit
- Add shebang to all programs
  • Loading branch information
Zach Zahos committed Sep 1, 2022
1 parent 17d4a06 commit c71f6e2
Show file tree
Hide file tree
Showing 17 changed files with 37 additions and 16 deletions.
1 change: 1 addition & 0 deletions PyAI.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyAI.PyAI import PyAI, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyBIN.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyBIN.PyBIN import PyBIN, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyDAT.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyDAT.PyDAT import PyDAT, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyFNT.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyFNT.PyFNT import PyFNT, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyGOT.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyGOT.PyGOT import PyGOT, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyGRP.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyGRP.PyGRP import PyGRP, LONG_VERSION
from PyMS.PyGRP.utils import grptobmp, bmptogrp
Expand Down
1 change: 1 addition & 0 deletions PyICE.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyICE.PyICE import PyICE, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyLO.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyLO.PyLO import PyLO, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyMPQ.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyMPQ.PyMPQ import PyMPQ, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyPAL.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyPAL.PyPAL import PyPAL, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyPCX.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyPCX.PyPCX import PyPCX, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PySPK.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PySPK.PySPK import PySPK, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyTBL.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyTBL.PyTBL import PyTBL, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyTILE.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyTILE.PyTILE import PyTILE, LONG_VERSION

Expand Down
1 change: 1 addition & 0 deletions PyTRG.pyw
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python2.7

from PyMS.PyTRG.PyTRG import PyTRG, LONG_VERSION

Expand Down
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ PyMS is a cross platform BroodWar modding suite written using [Python](http://ww

## Installation
1. **Install Python.** You should get the latest Python 2.7.x, currently that is [Python 2.7.12](https://www.python.org/downloads/release/python-2712/)
2. **Install PILLOW.** Use PIP, the Python package manager, to [install PILLOW](https://pillow.readthedocs.io/en/latest/installation.html#basic-installation) (PIL will also work)

**Note:** On Windows, you must ensure that Python is in your "Path" environment variable. If you use the MSI Installer there is an "Add Python.exe to path" option you should make sure is enabled during installation, otherwise you can [set it up manually](https://docs.python.org/2.7/using/windows.html#excursus-setting-environment-variables).
2. **Install Dependencies.** Use PIP (the Python package manager), to install all dependencies of PyMS by opening the command line, navigating to the PyMS folder, and running `python2.7 -m pip install -r requirements.txt`
3. **Download PyMS.** Always get the most up to date PyMS from [github](https://github.com/poiuyqwert/pyms) ([direct link](https://github.com/poiuyqwert/PyMS/archive/master.zip)). If you are updating PyMS, you can keep your settings files located in the Settings folder.

## Issues/Feedback
Expand Down Expand Up @@ -65,46 +67,46 @@ Even though the analytics is anonamous and has no sensitive information, you can
PyMS contains 16 programs to edit most of the file types you will encounter while modding.

### PyAI
[PyAI](/Help/Programs/PyAI.md) is used for editing AI .bin files.
[PyAI](/Help/Programs/PyAI.md) is used for editing AI [.bin](/Help/Files/aiscript.bin.md) files.

### PyBIN
PyBIN is used for editing dialog .bin files.
[PyBIN](/Help/Programs/PyBIN.md) is used for editing dialog [.bin](/Help/Files/UI_BIN.md) files.

### PyDAT
[PyDAT](/Help/Programs/PyDAT.md) is used for editing the various .dat files.
[PyDAT](/Help/Programs/PyDAT.md) is used for editing the various [.dat](/Help/Files/DAT/units.dat.md) files.

### PyFNT
PyFNT is used for converting .fnt Font files to and from .bmp files.
[PyFNT](/Help/Programs/PyFNT.md) is used for converting [.fnt](/Help/Files/FNT.md) Font files to and from [.bmp](/Help/Files/BMP.md) files.

### PyGOT
PyGOT is used for editing the Game Template .got files.
[PyGOT](/Help/Programs/PyGOT.md) is used for editing the Game Template [.got](/Help/Files/GOT.md) files.

### PyGRP
PyGRP is used for editing various graphics in .grp files.
[PyGRP](/Help/Programs/PyGRP.md) is used for editing various graphics in [.grp](/Help/Files/GRP.md) files.

### PyICE
PyICE is used for editing the graphics animation script .bin files.
[PyICE](/Help/Programs/PyICE.md) is used for editing the graphics animation script [.bin](/Help/Files/iscript.bin.md) files.

### PyLO
PyLO is used for editing the various offset .lo? files.
[PyLO](/Help/Programs/PyLO.md) is used for editing the various offset [.lo?](/Help/Files/LO.md) files.

### PyMPQ
PyMPQ is used for editing .mpq files.
[PyMPQ](/Help/Programs/PyMPQ.md) is used for editing [.mpq](/Help/Files/MPQ.md) files.

### PyPAL
PyPAL is used for editing the various image palette files (.pal, .wpe, etc.)
[PyPAL](/Help/Programs/PyPAL.md) is used for editing the various image [palette](/Help/Files/Palettes.md) files (.pal, .wpe, etc.)

### PyPCX
PyPAL is used for converting .pcx files to and from .bmp files.
[PyPAL](/Help/Programs/PyPAL.md) is used for converting [.pcx](/Help/Files/PCX.md) files to and from [.bmp](/Help/Files/BMP.md) files.

### PySPK
PySPK is used for editing the space paralax .spk files.
[PySPK](/Help/Programs/PySPK.md) is used for editing the space paralax [.spk](/Help/Files/SPK.md) files.

### PyTBL
PyTBL is used for editing the strings .tbl files.
[PyTBL](/Help/Programs/PyTBL.md) is used for editing the strings [.tbl](/Help/Files/TBL.md) files.

### PyTILE
PyTILE is used for editing the tileset files (.cv5, .vx4, .vf4, .vr4, .dddata)
[PyTILE](/Help/Programs/PyTILE.md) is used for editing the [tileset](/Help/Files/Tilesets/Tilesets.md) files ([.cv5](/Help/Files/Tilesets/CV5.md), .vx4, .vf4, .vr4, .dddata)

### PyTRG
PyTRG is used for editing triggers (.trg files)
[PyTRG](/Help/Programs/PyTRG.md) is used for editing triggers ([.trg](/Help/Files/TRG.md) files)
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#### This file lists dependencies required by PyMS which can be installed with pip
#### To install these dependencies run this command from the PyMS folder: python2.7 -m pip install -r requirements.txt
#### For help using pip you can view the documentation here: https://pip.pypa.io/en/latest/cli/pip_install/#
Pillow ~= 5.3.0

0 comments on commit c71f6e2

Please sign in to comment.