Skip to content

Commit

Permalink
Initial commit. Hello, world!
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperFromND committed Aug 22, 2023
0 parents commit 2cb2681
Show file tree
Hide file tree
Showing 8 changed files with 804 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# no release contents
bin/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 SuperFromND

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.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
all:
go build -o bin/iguana.exe src/main.go

release:
go build -o bin/iguana.exe -ldflags "-X main.version=1.0.0" src/main.go
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
![](https://raw.githubusercontent.com/SuperFromND/iguana/master/res/logo.svg)
---
***Iguana*** (**I**KEMEN **G**O **U**tility for **A**nnotating **N**onspecified **A**ttacks) is a tool for generating [movelist.dat](https://github.com/ikemen-engine/Ikemen-GO/wiki/Miscellaneous-Info#movelists) files for [I.K.E.M.E.N GO and M.U.G.E.N](https://github.com/ikemen-engine/Ikemen-GO) characters, using only their standard command definitions (.cmd) file. It is the successor/continuation of my JavaScript-based [IKEMEN GO Command List Generator](https://superfromnd.gitlab.io/ikemen-cmdlist/), written in Go and released as a standalone executable.

Iguana is a work-in-progress as of this writing (August 2023), and is not yet feature-complete or even feature-congruent with the aforementioned IKEMEN GO Command List Generator. Despite this, it is nevertheless functional enough to be deemed worthy of a public release.

## Usage
Iguana is a command line tool that requires at least one parameter, `-i`, to specify a command file to load. Additional options and parameters can be found by running Iguana by itself or with the `-h` argument.
```bash
$ iguana.exe -i path/to/file.cmd
```

By default, Iguana will output a file named `movelist.dat` in the same directory as the input file is located in. This location cannot currently be changed, but you *can* change its filename using the `-o` parameter.

## Features
Iguana is a work in progress, so right now it isn't capable of much outside of its basic functionality. Several features are planned to be implemented in the future, including:
- [ ] Formatting options
- [ ] Use Special Button Labels
- [ ] Compress Motions
- [ ] Label Moves with Header Comments
- [x] Remove one-button commands
- [ ] Annotate palette-specific moves
- [ ] Annotate air-state moves
- [ ] Customizable header colors
- [ ] Button remapping support
- [ ] Automatic `[Movelist]` patching of character.def files
- [ ] Bulk processing of entire `chars` folders

## Building
Iguana requires at least Go version 1.13 to compile, due to [the INI library](https://github.com/go-ini/ini) requiring it. Aside from that, you shouldn't have too much trouble building as it's otherwise standard Go.
```
$ git clone https://github.com/SuperFromND/iguana.git
$ cd iguana
$ make
```

## Licensing
Iguana, as well as its logo, is [available under the MIT License.](https://raw.githubusercontent.com/SuperFromND/iguana/main/LICENSE) <3
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/superfromnd/iguana

go 1.13

require gopkg.in/ini.v1 v1.67.0 // indirect
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
124 changes: 124 additions & 0 deletions res/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2cb2681

Please sign in to comment.