Skip to content

Commit 2ce4473

Browse files
Add files via upload
1 parent e12ec35 commit 2ce4473

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

BEEMOD2/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
[![BEE2.4 Releases](https://img.shields.io/github/downloads/BEEmod/BEE2.4/total.svg?label=App)](https://github.com/BEEmod/BEE2.4/releases)
2+
[![BEE2-items Releases](https://img.shields.io/github/downloads/BEEmod/BEE2-items/total.svg?label=Packages)](https://github.com/BEEmod/BEE2-items/releases)
3+
4+
### Please read the [Contributing Guidelines](https://github.com/BEEmod/BEE2-items/blob/master/.github/contributing.md) and [FAQ](https://github.com/BEEmod/BEE2-items/wiki/FAQ) before opening an issue.
5+
6+
![BEE2 Icon](https://raw.githubusercontent.com/BEEmod/BEE2.4/master/bee2.ico)
7+
# Better Extended Editor 2 version 4 #
8+
## Portal 2 Mod Tool
9+
The BEE2 allows reconfiguring Portal 2's Puzzlemaker editor to use additional items, reskin maps for
10+
different eras, and configure many other aspects. All vanilla items have been upgraded with additional
11+
bugfixes and improvements.
12+
13+
The packages (item, style, etc definitions) are in the [BEE2-Items](https://github.com/BEEmod/BEE2-items) repository.
14+
15+
[Discord Server](https://discord.gg/hnGFJrz)
16+
17+
## Download and Use
18+
- Download the latest releases of the BEE2.4 and items from the following pages:
19+
- [Application](https://github.com/BEEmod/BEE2.4/releases)
20+
- [Item Packages](https://github.com/BEEmod/BEE2-items/releases)
21+
- Extract the contents of the Application release anywhere you like. _e.g. `C:\BEE2.4`_
22+
- Place extracted package folder in the root BEE2 folder. _e.g. `C:\BEE2.4\packages`_
23+
- To run, locate the BEE2 application in the app folder and execute it. _e.g. `C:\BEE2.4\BEE2.exe`_
24+
25+
### Used Libraries ###
26+
- [Python](https://www.python.org/)
27+
- [TKinter/TTK](https://tcl.tk/)
28+
- [pyglet](https://bitbucket.org/pyglet/pyglet/wiki/Home) and [AVBin](http://avbin.github.io/AVbin/Home/Home.html) (for sounds, not required)
29+
- [Pillow](https://python-pillow.github.io/)
30+
- [noise](https://pypi.python.org/pypi/noise/) (For perlin/simplex noise, as `src/perlin.py`)
31+
- [markdown](https://pythonhosted.org/Markdown/)
32+
- [cython](https://cython.org/)
33+
- [PyInstaller](http://www.pyinstaller.org/)
34+
35+
## Building from Source ##
36+
37+
### PyPI list: ###
38+
* pillow (On Linux this may need to be installed via system package manager with the TK component: `python-pillow`, `python-pillow.imagetk`)
39+
* markdown
40+
* pyglet
41+
* PyInstaller
42+
* cython
43+
* requests (For compilation only.)
44+
45+
[AVBin](http://avbin.github.io/AVbin/Download.html) must also be installed, to provide codecs for pyglet.
46+
47+
### Compilation ###
48+
First, grab the 2 git repositories you need:
49+
50+
git clone https://github.com/TeamSpen210/srctools.git
51+
git clone https://github.com/BEEmod/BEE2.4.git
52+
53+
Switch to the srctools repo, and install the package:
54+
55+
cd srctools/
56+
python setup.py install
57+
58+
Finally, switch to the BEE2.4 repo and build the compiler, then the application:
59+
60+
cd BEE2.4/src/
61+
pyinstaller --distpath ../dist/ --workpath ../build_tmp compiler.spec
62+
pyinstaller --distpath ../dist/ --workpath ../build_tmp BEE2.spec
63+
64+
The built application is found in `BEE2.4/dist/BEE2/`.
65+
Copy `BEE2.4/dist/BEE2/` into this folder as well.
66+
To generate the packages zips, either manually zip the contents of each folder or
67+
use the `compile_packages` script in BEE2-items.
68+
This does the same thing, but additionally removes some unnessersary content
69+
to decrease file sizes - comments, blank lines, hidden visgroups.

0 commit comments

Comments
 (0)