Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ShadelessFox committed Feb 21, 2024
1 parent c56189b commit fce52c8
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,47 @@
[![Java](https://img.shields.io/badge/Java-17-orange?logo=openjdk&logoColor=white)](https://adoptium.net/temurin/releases/?package=jre&arch=x64&version=17)
[![Java](https://img.shields.io/badge/Java-17-orange?logo=openjdk&logoColor=white)](https://adoptium.net/temurin/releases/?package=jre&arch=x64&version=17)
[![Download](https://img.shields.io/github/v/release/ShadelessFox/decima?label=Download&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij4KCTxwYXRoIGZpbGw9IndoaXRlIiBkPSJNMTEuMiAwYS44LjggMCAwIDAtLjguOHYxMS40TDcuMjYgOS40NGEuODAzLjgwMyAwIDAgMC0xLjEzLjA3NGwtMS4wNSAxLjJhLjguOCAwIDAgMCAuMDczIDEuMTNsNi4zMyA1LjU0YS43OTUuNzk1IDAgMCAwIDEuMDUgMGw2LjMyLTUuNTRhLjguOCAwIDAgMCAuMDc0LTEuMTNsLTEuMDUtMS4yYS44MDQuODA0IDAgMCAwLTEuMTMtLjA3NGwtMy4xNCAyLjc2Vi44YS44LjggMCAwIDAtLjgtLjh6bS04IDIwLjhhLjguOCAwIDAgMC0uOC44djEuNmEuOC44IDAgMCAwIC44LjhoMTcuNmEuOC44IDAgMCAwIC44LS44di0xLjZhLjguOCAwIDAgMC0uOC0uOHoiPjwvcGF0aD4KPC9zdmc+Cg==)](https://github.com/ShadelessFox/decima/releases/latest)
[![Discord](https://img.shields.io/discord/1012475585605414983?label=Chat&logo=discord&logoColor=white)](https://discord.gg/Gt4gkMwadB)
[![Support](https://img.shields.io/badge/Support-Buy_Me_A_Coffee-yellow?logo=buymeacoffee&logoColor=white)](https://adoptium.net/temurin/releases/?package=jre&arch=x64&version=17)

# Decima Workshop

Decima Workshop is an open-source modding tool for games powered by Decima engine. Its goal is to allow viewing, creating, and editing "packfile" archives and contained "core" files inside.
Decima Workshop is an open-source modding tool for games powered by [Decima engine](https://en.wikipedia.org/wiki/Decima_(game_engine)). It aims to allow viewing and editing of game files and assets.

![](https://github.com/ShadelessFox/decima/assets/35821147/22a3fb92-8009-499e-bc30-583607b6ba4b)

# Supported games
### Running

| Game | Platform |
|---------------------------------|----------|
| Death Stranding | PC |
| Death Stranding: Director's Cut | PC |
| Horizon Zero Dawn | PC |
1. Make sure you have **Java 17** installed. We recommend using [Adoptium](https://adoptium.net/temurin/releases/?arch=x64&version=17&package=jre)
2. Download the latest version of the application from the [releases page](https://github.com/ShadelessFox/decima/releases/latest)
3. Unzip the downloaded archive and launch using `decima.bat` on Windows or `decima` on Linux
4. For further steps, [check out the wiki](https://github.com/ShadelessFox/decima/wiki/Getting-started)

# Using the application
### Prerequisites
- Java 17 (**JRE** for [running](#running), **JDK** for [building](#building); we use and recommend [Adoptium](https://adoptium.net/))
- Git client (for [building](#building))
- Windows 10 (64-bit)
#### Nightly builds

### Running
1. Download a release from the [releases](https://github.com/ShadelessFox/decima/releases) page
2. Unzip the downloaded archive
3. Launch using `bin/decima.bat`
4. For further steps, [check out the wiki](https://github.com/ShadelessFox/decima/wiki/Getting-started)
If you want to try the latest features and improvements, you can download the latest build from the [actions page](https://github.com/ShadelessFox/decima/actions).
Click on the latest workflow run and download the artifact from the `Artifacts` section.

### Building
**Make sure you are using the minimum required JRE version or the build will fail**
### Build

Open your favorite terminal app and execute the following commands in the specified order:
1. `git clone https://github.com/ShadelessFox/decima`
2. `cd decima`
3. `./gradlew build`
1. Make sure you have **Java 17** installed. We recommend using [Adoptium](https://adoptium.net/temurin/releases/?arch=x64&version=17&package=jdk)
2. Make sure you have **Git** installed. Alternatively, you can download the source code as a ZIP archive and extract it
3. Open the terminal and execute the following commands:
1. `git clone https://github.com/ShadelessFox/decima`
2. `cd decima`
3. `gradlew build`

Ready-to-use distributions can be found under the `build/distributions` directory. To run the application, see [Running](#running).

Ready-to-use distribution can be found under the `build/distributions` directory. See [Running](#running) at step 2
## Supported games

| Game | Platform |
|---------------------------------|----------|
| Death Stranding | PC |
| Death Stranding: Director's Cut | PC |
| Horizon Zero Dawn | PC |

# License
## License
This project is licensed under the GPL-3.0 license.

This project is not sponsored nor related to Guerrilla Games, Kojima Productions, Sony Interactive Entertainment, and others.
Expand Down

0 comments on commit fce52c8

Please sign in to comment.