From 8d43eb91dfd508f30254dd61c5fb4d4b2de52f30 Mon Sep 17 00:00:00 2001 From: Josh Freeman Date: Wed, 13 Dec 2017 11:04:39 +0000 Subject: [PATCH] Update readmes --- README.md | 49 ++++++++++++++++++++--------------------------- README_ARCHIVE.md | 18 +++++++++++++++++ 2 files changed, 39 insertions(+), 28 deletions(-) create mode 100644 README_ARCHIVE.md diff --git a/README.md b/README.md index fc241f120..e9267ee63 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,41 @@ # XIV-Datamining + This repository is to serve as a place to share data mining information related to Final Fantasy XIV. All findings and knowledge that each member discovers will be provided here for all in the FFXIV Community to read, learn and use. Huge thanks to the community team members involved: + - [Ioncannon](https://www.reddit.com/user/Ioncannon) from [FFXIV Explorer](http://ffxivexplorer.fragmenterworks.com) - [Clorifex](https://www.reddit.com/user/Clorifex) from [GarlandTools](http://www.garlandtools.org/db/) - [Hezkezl](https://www.reddit.com/user/Hezkezl) for being awesome --- - -## Helping out -To help out, first you need a tool. They're all listed below. FFXIV Explorer can list data information through its application SaintCoinach has Godbert which can also do the same. Each tool provides a viewer for the EXD information as well as the index offsets in the header column. - -If you find a match between data, just throw up an Issue and we can sort it from there :D - --- -## Data Mining Tools -### FFXIV Explorer -- Built by: https://www.reddit.com/user/Ioncannon -- Download: http://ffxivexplorer.fragmenterworks.com/ +## Helping out -This is one of the best applications to just get stuck in with and get going somewhere. It is very well polished, has an excellent 3D model viewer. +Getting started in datamining is quite easy. If you enjoy digging around CSV database files then you've come to the right place! The best place to start would be: + +- Download this repository and start looking at the files in the `/csv` folder +- Download **Saint Coinach** and use either the `SaintCoinach.Cmd` to rip data, images, maps etc or `Godbert` to view data. + - Saint provides releases: https://github.com/ufx/SaintCoinach/releases + +If you find a connection between files or an identification of data, throw up an issue on the repository and it will be sorted :) + +- Connection between files could be an number in 1 column that matches the numbers in another column or even another file +- Identification of data could be values in a column that have a meaning and a pattern can be observed (eg ClassJob ID, or Craft Level) + +# The tools of the trade ### Saint Coinach -- Written by: Rogueadyn -- GitHub: https://github.com/Rogueadyn/SaintCoinach -- Updates by: Clorifex + +- Written by: Clorifex and Rogueadyn - GitHub: https://github.com/ufx/SaintCoinach +- Downloads: https://github.com/ufx/SaintCoinach/releases + - SaintCoinach.Cmd is a tool to rip data (csv, music, icons, maps, etc) + - Godbert is a *viewer* tool to browse data. A great tool showing really impressive results, it will allow you to view and export a lot of data. The source is all open for your luxery. -### XIVDB Tool -- Original Developer: [Ahom](https://github.com/ahom) -- GitHub: https://github.com/viion/XIVDB-Dat-Tool - -This tool is highly expiremental, built in Python, it is broken in some areas. - -### FFXIV Reverse -- Written by: [Ahom](https://github.com/ahom) -- Forked: https://github.com/viion/ffxiv_reverse -- Github: https://github.com/ahom/ffxiv_reverse - - --- ### APIs -The XIVDB website has an API here: https://github.com/viion/XIVDB-API +The XIVDB website has an API here: https://github.com/xivdb/api diff --git a/README_ARCHIVE.md b/README_ARCHIVE.md new file mode 100644 index 000000000..b3ba72948 --- /dev/null +++ b/README_ARCHIVE.md @@ -0,0 +1,18 @@ +Archive information for the ffxiv-datamining repository. + +--- + +Old tools kept for archive/referense purposes, these are not being developed and considered dead/broken: + + +## No longer supported + +These apps may get occational patch updates but no feature changes. + +- (Java) FFXIV Explorer: http://ffxivexplorer.fragmenterworks.com/ + - by: https://www.reddit.com/user/Ioncannon + +## 100% dead + +- (Python) FFXIV Data Tool: https://github.com/viion/XIVDB-Dat-Tool +- (C++) FFXIV Reverse: https://github.com/viion/ffxiv_reverse \ No newline at end of file