Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radiatoryang/scopa
Unity level design plugin that adds support for Quake .MAP / Half-Life .RMF / Source .VMF, Q1 HL1 .WAD textures, and .FGD export.
https://github.com/radiatoryang/scopa
3d environment game game-development half-life half-life-2 hammer level-design level-editor mod modeling quake quake-engine source-engine trenchbroom unity unity-editor unity-package unity3d
Last synced: 28 days ago
JSON representation
Unity level design plugin that adds support for Quake .MAP / Half-Life .RMF / Source .VMF, Q1 HL1 .WAD textures, and .FGD export.
- Host: GitHub
- URL: https://github.com/radiatoryang/scopa
- Owner: radiatoryang
- License: mit
- Created: 2022-03-13T22:24:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-29T23:02:00.000Z (11 months ago)
- Last Synced: 2024-09-30T18:02:28.192Z (about 1 month ago)
- Topics: 3d, environment, game, game-development, half-life, half-life-2, hammer, level-design, level-editor, mod, modeling, quake, quake-engine, source-engine, trenchbroom, unity, unity-editor, unity-package, unity3d
- Language: C#
- Homepage:
- Size: 1.12 MB
- Stars: 115
- Watchers: 16
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Scopa
*Scopa* ("broom" in Latin) is a Unity level design plugin that adds supports for various Quake / Half-Life / Source file formats. Like [Qodot](https://github.com/QodotPlugin/qodot-plugin) but for Unity. To build levels, we strongly recommend [TrenchBroom](https://github.com/TrenchBroom/TrenchBroom) and the Quake 1 .MAP file format.
# WARNING: in unstable early development, not ready for production use yet, might change a lot or break
- [MAP, RMF, VMF, JMF import](Documentation~/MapImporter.md) generates model prefab with meshes, colliders, entities. (note: only core Q1 MAP features)
- [WAD import](Documentation~/WadImporter.md) / [WAD export](Documentation~/WadExporter.md) (Quake 1 WAD2 / Half-Life WAD3 textures format, not Doom)
- FGD creator can export entity definitions out to TrenchBroom
- works at editor time or runtime (for modding support)
## Installation
This is a [Unity Package](https://docs.unity3d.com/Manual/PackagesList.html) for Unity 2020.1 or later. To install, open [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) and add `https://github.com/radiatoryang/scopa.git` [(more info and help)](https://docs.unity3d.com/2021.2/Documentation/Manual/upm-ui-giturl.html) (TIP: You'll probably need to [install Git](https://git-scm.com/downloads) first.) There's zero dependencies, but if you have [Burst](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) installed then map imports will be significantly faster.
## Usage
Put a supported file (MAP, RMF, VMF, JMF, WAD) in your `/Assets/` folder and it'll import automatically, just like any other asset file. Defaults are tuned to typical Quake / Half-Life [level design metrics](https://book.leveldesignbook.com/process/blockout/metrics), 32 map units = 1 Unity meter.
**Do your edits in the level editor, not in Unity!** Any in-editor changes may be erased when you re-import the .MAP again. Treat the .MAP file as the [single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth).
For more info (i.e. runtime import for modding), see the full [Documentation](Documentation~/Index.md).
## Limitations
**This package doesn't have game code.** It just imports and exports files. You still have to make the game yourself.
**We treat the Quake 1 Trenchbroom .MAP v220 file format as the core feature set. Anything beyond these core features (brushes and entity keyvalue pairs) is not supported.** For more info, see the [Map Importer docs](Documentation~/MapImporter.md).
## Contributions
- Issues currently ARE NOT ACCEPTED at this time. Development is still very early.
- Pull Requests ARE ACCEPTED if you know what you're doing / it can be merged easily / it's not a major feature that I'll have to maintain.
## Acknowledgments / Credits
- lots of file format handling from [Sledge Formats](https://github.com/LogicAndTrick/sledge-formats)
- GPU-based texture resizing from [Unity GPU Texture Resize](https://github.com/ababilinski/unity-gpu-texture-resize)
- color palette generation from [cSharpColourQuantization](https://github.com/bacowan/cSharpColourQuantization/blob/master/ColourQuantization/MedianCut.cs)
- looking for a BSP plugin? try [Unity3D BSP Importer](https://github.com/wfowler1/Unity3D-BSP-Importer)