Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
The MIT License (MIT)
MIT License

Copyright (c) 2019 fireundubh <fireundubh@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
72 changes: 65 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,73 @@
**Pyro** is a parallelized incremental build system for _Skyrim Classic_ (TESV), _Skyrim Special Edition_ (SSE), and _Fallout 4_ (FO4) projects. Pyro provides mod authors with an all-in-one tool for compiling Papyrus scripts, packaging BSA and BA2 archives, and preparing builds for distribution. Pyro can be integrated as an external tool into any IDE, allowing mod authors to "Instant Build" projects with a single hotkey.

# Pyro   [![Badge License]][License]   [![Badge CI]][Actions]

## Binaries
*A parallelized incremental build system for **Bethesda** games.*

Latest build from master branch:
<br>
<br>

[![](https://github.com/fireundubh/pyro/workflows/GitHub%20CI/badge.svg)](https://github.com/fireundubh/pyro/actions)
<div align = center>

See also: [Releases](https://github.com/fireundubh/pyro/releases)
---

[![Button Releases]][Releases]   
[![Button Documentation]][Wiki]

## Documentation
---

</div>

<br>
<br>

## Supported

- **Skyrim Special Edition**  ( SSE )

- **Skyrim Classic**  ( TESV )

- **Fallout 4**  ( FO4 )

<br>
<br>

## Features

- All-in-one tool for:

- Compiling **[Papyrus]** scripts

- Packaging **BSA** / **BA2** archives

- Preparing builds for distribution

<br>

- Can be integrated into any IDE as an external tool <br>
to allow modders to `Instant Build` projects with <br>
a single press of a button.

<br>


<!----------------------------------------------------------------------------->

[Releases]: https://github.com/fireundubh/pyro/releases
[Papyrus]: https://ck.uesp.net/wiki/Papyrus_Introduction
[Actions]: https://github.com/fireundubh/pyro/actions
[Wiki]: https://wiki.fireundubh.com/pyro

[License]: LICENSE


<!---------------------------------[ Badges ]---------------------------------->

[Badge License]: https://img.shields.io/badge/License-MIT-ac8b11.svg?style=for-the-badge&labelColor=yellow
[Badge CI]: https://img.shields.io/github/workflow/status/fireundubh/pyro/GitHub%20CI?color=93224f&style=for-the-badge&labelColor=CB2E6D


<!--------------------------------[ Buttons ]---------------------------------->

[Button Documentation]: https://img.shields.io/badge/Documentation-2396F3?style=for-the-badge&logoColor=white&logo=Wikipedia
[Button Releases]: https://img.shields.io/badge/Releases-569A31?style=for-the-badge&logoColor=white&logo=AzureArtifacts

External link: [Pyro Wiki](https://wiki.fireundubh.com/pyro)