Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
glitchingdot authored Aug 5, 2023
1 parent 0e08168 commit 4ee1f74
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# UltraPattern
A Blender addon to import, create, modify, and export Cyber Grind Pattern files to ULTRAKILL
# UltraPattern (1.0.0)
A Blender add-on to import, create, modify, and export Cyber Grind Pattern files for ULTRAKILL

Use UltraPattern to build and visualize new patterns fast, set up animation environments quickly, and debug broken patterns!

## Features
* Importing and exporting Cyber Grind patterns 📦
* Create new patterns 💡
* Prefab editing 📝
* Visualze prefabs with custom colors 🌈

*And more to come!*

## Requirements
UltraPattern was built using Blender **3.6.1**, but it is compatible with most modern versions of Blender
*hopefully*, compatibility cannot be 100% ensured

## Installation
* Download the add-on from the Releases page: [UltraPattern](https://github.com/jackk25/UltraPattern/releases/latest)
* Do **NOT** unzip the file
* In Blender, go to *Edit > Preferences > Add-ons* and click on *Install*
* Select the downloaded file, press *Install Add-on*
* Click on the check box next to the text

Congrats, you've just installed UltraPattern! 🎉

## Usage
* In the 3D View, press N to open the sidebar
* Click on the tab labled "UltraPattern"
* To get started, either import a pattern with *Import CGP* or create a blank pattern with *Create Blank Pattern*
* To edit a pillar's prefab, click on it, and you will see a new panel named "Pillar" appear
* Use the menu to edit the pillar's prefab
* To export, select the pattern's collection and click *Export CGP*

## Notes
* UltraPattern is currently in a **pre-release** state, so certain features, such as:
* Mass-select prefab editing
* Material generation
are currently **unavailable**, but will be coming **soon**

0 comments on commit 4ee1f74

Please sign in to comment.