Skip to content

Commit

Permalink
chore: Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
araguma committed Aug 1, 2023
0 parents commit 4d4fe3b
Show file tree
Hide file tree
Showing 11 changed files with 1,538 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
on:
push:
branches:
- main

permissions:
contents: write
pull-requests: write

name: release-please

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3
with:
release-type: node
package-name: release-please-action
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
dist/
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# HoloCure Save Editor

Holocure Save Editor is a save editor for the fan game [HoloCure](https://kay-yu.itch.io/holocure) created by Kay Yu.

It comes with a `HoloEdit` class that has chainable methods for quick and easy editing as well as a `data` property for more customized editing.

## Use Cases

- You lost your save file like me and don't want to grind the game again
- You want a fast way to switch between different game configurations
- You want to experiment with upgrade levels that are not possible in the game

## Installation

```bash
npm i holocure-save-editor
```

## Quick Start

```typescript
import HoloEdit from 'holocure-save-editor';

// Create an editor from a save file
const edit = new HoloEdit('path/to/save_n.dat');

// Use method chaining to edit the save file
edit
.coin(100)
.outfit('faunaAlt1', true)
.gRank('fauna', 21)
.achievement('faunaGachikoi', true);

// Use the data property to edit the save file
edit.data.mobUp = 10;
edit.data.ATK = 1;

// Save the edited save file
// Note: It is recommended that you either run console.log(edit.data) to verify the changes, or save the edited save file to a different file
edit.save('path/to/output/save_n.dat'); // You can use edit.save() to overwrite the original save file
```

## Documentation

### coin(amount)

### achievement(achievementId, unlocked)

### tear(generationId, amount)

### gRank(characterId, rank)

### outfit(outfitId, unlocked)

### stage(stageId, unlocked)

### item(itemId, unlocked)

### weapon(weaponId, unlocked)

### collab(collabId, unlocked)

### save([savePath])

## Roadmap

- Support for the upcoming 0.6 version
- More commonly used edit methods
Loading

0 comments on commit 4d4fe3b

Please sign in to comment.