{"id":13696859,"url":"https://github.com/ericwa/ericw-tools","last_synced_at":"2025-04-08T07:33:08.423Z","repository":{"id":26706844,"uuid":"30164011","full_name":"ericwa/ericw-tools","owner":"ericwa","description":"Quake/Hexen 2 Map compiling tools - branch of http://disenchant.net/utils","archived":false,"fork":false,"pushed_at":"2025-02-17T05:49:21.000Z","size":19005,"stargazers_count":369,"open_issues_count":121,"forks_count":62,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-01T05:33:23.679Z","etag":null,"topics":["lighting","qbsp","quake"],"latest_commit_sha":null,"homepage":"http://ericwa.github.io/ericw-tools","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ericwa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-02-01T23:43:19.000Z","updated_at":"2025-03-28T11:13:43.000Z","dependencies_parsed_at":"2024-03-08T20:34:11.505Z","dependency_job_id":"7cda1cbe-6d33-4a7b-9d70-b4809b0c8b9e","html_url":"https://github.com/ericwa/ericw-tools","commit_stats":{"total_commits":4062,"total_committers":27,"mean_commits":"150.44444444444446","dds":0.3175775480059084,"last_synced_commit":"0f1a7186d66dcb6f8f1ca74462dacf2bdce8e44f"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericwa%2Fericw-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericwa%2Fericw-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericwa%2Fericw-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericwa%2Fericw-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericwa","download_url":"https://codeload.github.com/ericwa/ericw-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247796333,"owners_count":20997553,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lighting","qbsp","quake"],"created_at":"2024-08-02T18:00:48.668Z","updated_at":"2025-04-08T07:33:08.399Z","avatar_url":"https://github.com/ericwa.png","language":"C++","funding_links":[],"categories":["Mapping"],"sub_categories":["QuakeWorld"],"readme":"## ericw-tools\r\n - Website:         http://ericwa.github.io/ericw-tools\r\n - Maintainer:      Eric Wasylishen (AKA ericw)\r\n - Email:           ewasylishen@gmail.com\r\n\r\n### Original tyurtils:\r\n\r\n - Website: http://disenchant.net\r\n - Author:  Kevin Shanahan (AKA Tyrann)\r\n - Email:   tyrann@disenchant.net\r\n\r\n[![Build status](https://ci.appveyor.com/api/projects/status/7lpdcy7l3e840u70?svg=true)](https://ci.appveyor.com/project/EricWasylishen/ericw-tools)\r\n\r\n## About\r\n\r\nericw-tools is a branch of Tyrann's quake 1 tools, focused on\r\nadding lighting features, mostly borrowed from q3map2. There are a few\r\nbugfixes for qbsp as well. Original readme follows:\r\n\r\nA collection of command line utilities for building Quake levels and working\r\nwith various Quake file formats. I need to work on the documentation a bit\r\nmore, but below are some brief descriptions of the tools.\r\n\r\nIncluded utilities:\r\n\r\n - qbsp    - Used for turning a .map file into a playable .bsp file.\r\n\r\n - light   - Used for lighting a level after the bsp stage. This util was previously known as TyrLite\r\n\r\n - vis     - Creates the potentially visible set (PVS) for a bsp.\r\n\r\n - bspinfo - Print stats about the data contained in a bsp file.\r\n\r\n - bsputil - Simple tool for manipulation of bsp file data\r\n\r\nSee the doc/ directory for more detailed descriptions of the various\r\ntools capabilities.  See changelog.md for a brief overview of recent\r\nchanges or https://github.com/ericwa/ericw-tools for the full changelog and\r\nsource code.\r\n\r\n## Compiling\r\n\r\nDependencies: Embree 3.0+, TBB (TODO: version?), Sphinx (for building manuals)\r\n\r\n### Ubuntu\r\n\r\nNOTE: Builds using Ubuntu's embree packages produce a significantly slower `light` (i.e. over twice as slow) than ones released on Embree's GitHub. See `build-linux-64.sh` for a better method. \r\n\r\n```\r\nsudo apt install libembree-dev libtbb-dev cmake build-essential g++\r\nsudo apt install python3-pip\r\npython3 -m pip install sphinx_rtd_theme\r\nexport PATH=\"~/.local/bin/:$PATH\"\r\ngit clone --recursive https://github.com/ericwa/ericw-tools\r\ncd ericw-tools\r\nmkdir build\r\ncd build\r\ncmake ..\r\n```\r\n\r\n### Windows\r\n\r\nExample using vcpkg (32-bit build):\r\n\r\n```\r\ngit clone --recursive https://github.com/ericwa/ericw-tools\r\ncd ericw-tools\r\n\r\n# creates a python virtual environment in the directory `sphinx-venv`\r\n# and install sphinx (for building the docs)\r\npy.exe -m venv sphinx-venv\r\n.\\sphinx-venv\\Scripts\\Activate.ps1\r\npy.exe -m pip install -r docs/requirements.txt\r\n\r\ngit clone https://github.com/microsoft/vcpkg\r\n.\\vcpkg\\bootstrap-vcpkg.bat\r\n\r\n# NOTE: vcpkg builds for 32-bit by default\r\n# NOTE: takes 30+ minutes\r\n.\\vcpkg\\vcpkg install embree3\r\nmkdir build\r\ncd build\r\n\r\n# PowerShell syntax for getting current directory -\r\n# otherwise, replace with absolute path to \"vcpkg/scripts/buildsystems/vcpkg.cmake\"\r\ncmake .. -DCMAKE_TOOLCHAIN_FILE=\"$(pwd)/../vcpkg/scripts/buildsystems/vcpkg.cmake\" -DCMAKE_GENERATOR_PLATFORM=Win32 -DSPHINX_EXECUTABLE=\"$(pwd)/../sphinx-venv/Scripts/sphinx-build.exe\"\r\n```\r\n\r\n#### IDE Tips - CLion\r\n\r\n- Modify the \"Google Test\" run/debug configuration template to have `--gtest_catch_exceptions=0`, otherwise the  \r\n  debugger doesn't stop on exceptions (segfaults etc.)\r\n\r\n  (see: https://youtrack.jetbrains.com/issue/CPP-29559/Clion-LLDB-does-not-break-on-SEH-exceptions-within-GTest)\r\n\r\n### macOS 10.15\r\n\r\n```\r\nbrew install embree tbb\r\npython3 -m pip install sphinx_rtd_theme\r\ngit clone --recursive https://github.com/ericwa/ericw-tools\r\ncd ericw-tools\r\nmkdir build\r\ncd build\r\ncmake .. -GXcode -DCMAKE_PREFIX_PATH=\"$(brew --prefix embree);$(brew --prefix tbb)\"\r\n```\r\n\r\n## Credits\r\n\r\n- Kevin Shanahan (AKA Tyrann) for the original [tyrutils](http://disenchant.net/utils)\r\n- id Software (original release of these tools is at https://github.com/id-Software/quake-tools) \r\n- rebb (ambient occlusion, qbsp improvements)\r\n- q3map2 authors (AO, sunlight2, penumbra, deviance are from [q3map2](https://github.com/TTimo/GtkRadiant/tree/master/tools/quake3/q3map2))\r\n- Spike (hexen 2 support, phong shading, various features)\r\n- MH (surface lights based on MHColour)\r\n- mfx, sock, Lunaran (testing)\r\n- Thanks to users at [func_msgboard](http://www.celephais.net/board/forum.php) for feedback and testing\r\n\r\n## License\r\n\r\n    This program is free software; you can redistribute it and/or modify\r\n    it under the terms of the GNU General Public License as published by\r\n    the Free Software Foundation; either version 2 of the License, or\r\n    (at your option) any later version.\r\n\r\n    This program is distributed in the hope that it will be useful,\r\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\r\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r\n    GNU General Public License for more details.\r\n\r\n    You should have received a copy of the GNU General Public License\r\n    along with this program; if not, write to the Free Software\r\n    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r\n\r\nBuilds using Embree are licensed under GPLv3+ for compatibility with the\r\nApache license.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericwa%2Fericw-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericwa%2Fericw-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericwa%2Fericw-tools/lists"}