GithubHelp home page GithubHelp logo

adamboy7 / open-journal Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 249 KB

Open Journal is an easily customizable and searchable index of items and loot. Currently configured for Kingdom Hearts 2, items can be easily created or removed, added to drop tables, and can can be programmatically searched for and found in defined locations.

License: GNU General Public License v3.0

Python 100.00%

open-journal's Introduction

Open-Journal

Open Journal is an easily customizable and searchable index of items and loot. Currently configured for Kingdom Hearts 2 Final Mix, items can be easily created or removed, added to drop tables, and can can be programmatically searched for and found in defined locations.

How it works:

Item Index and Enemy Index

The backbone of the journal is designed to be really simple and easy to edit. Every item, weapon, and ability is defined in item_Index.txt. Every Enemy is defined in enemy_Index.txt. The structure of any given item (Enemies follow the same format, just a different set of ID's and icons) is broken into three simple parts seperated by colons. Add a Number:Name:Number to an index and you've created and indexed a custom item/enemy.

ID# : Name : Icon

  • ID#: The number assigned to the item, usually it's position in the index starting from 0. Items don't have to be in order though and gaps are allowed. Supplied indexies are based off of in game values found in RAM using Crazycatz00's English Patch.

  • Name: What you'd like to call your item/ability/enemy. Supplied names are based off of the 2.5 HD remake. Any character including spaces are allowed, except colon ":" and hashtag "#". Colon is used as the index divider, and any line with a hashtag will be treated as a comment.

  • Icon: A number loosely corisponding to a grid of icons found in fontimage.bar on the disc itself. Enemies use a different set of icons, 1 for Heartless, 2 for Nobodies, 3 for other (Bosses and other humanoid enemies)

Enemy Drops

Enemy drops are defined and stored in the Drops folder. The name of the enemy is the name of the file (Case sensitive, needs to match a name in enemy_Index). The drops are defined by putting existing item ID numbers inside an enemy's file. Add an ID number to an enemy's file, it now "drops" that item.

World structures:

Currently enemy and item indexes are stored on the root folder. However thanks to Glob you're able to place your own worlds in the Worlds folder, populate them with chests, enemies, rewards, and have your world be automatically detected and indexed. Similar to drops, World files only use ID numbers. Names and icons are already defined in the main files. Create and name a folder in Worlds, place chests, Enemies, or rewards.txt inside and you're created a custom world.

  • Chests: A list of item ID numbers corresponding to ID's found in item_Index.txt

  • Enemies: A list of enemy ID numbers corresponding to ID's found in enemy_Index.txt

  • Rewards: A list of item ID numbers corresponding to ID's found in item_Index.txt

Todo:

  • An actual GUI
  • Impliment enemies/chests only being availible on a given visit
  • Puzzle pieces
  • Better define chest locations (World/Closest Save/Room/Coordinates maybe?)
  • Custom art
  • Gummi treasures
  • Impliment a texture pack system to load user supplied images (Avoid uploading copyrighted textures as much as reasonably possible)

Wishful Thinking:

  • Impliment Crazycatz00 or Xeeynamo's unpacking tool to automatically generate indexes, images, and descriptions
  • Become part of Xeeynamo's OpenKH project
  • Get hired by Square Enix
  • Get Square Enix to impliment search features into the game

open-journal's People

Contributors

adamboy7 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.