Skip to content

Commit 952ed44

Browse files
committed
Update ReadMe.md with new contributing details
1 parent 00ec71f commit 952ed44

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ Database files for use with [Firefall DISASM Name Manager](https://github.com/th
44
## How to Contribute
55
When working on reverse engineering the client, you can store subroutine names within the database files used by [Firefall DISASM Name Manager](https://github.com/themeldingwars/Firefall-DISASM-Name-Manager). These can then be committed back into this repository for users to add to their own local databases.
66

7+
### Allowed Charcters In Names
8+
The following is a list of characters approved for names that have been confirmed to be handled gracefully in all supported applications.
9+
10+
`.:_0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz`
11+
12+
Pull Requests will not be merged that contain characters outside of the above list unless ample reasoning is provided for why the list should be expanded.
13+
14+
### Duplicate Name Handling
15+
When duplicate names occur, they should be handled by appending `_#` to the end of the name. Where the `#` is incremented for each additional occurrence.
16+
717
### For Public Users
818
1. Verify your local database includes the latest version of the matching Client Version database on this repo.
919
* You can download the latest version from here and import into yours to update it.
@@ -12,4 +22,4 @@ When working on reverse engineering the client, you can store subroutine names w
1222
3. Create a Pull Request for the database to be placed into the proper directory.
1323
* For example, Client Version beta-1962 would be located in `production\beta\FF_DISASM_V1962.json`.
1424

15-
NOTE: This tool does not currently perform automatic deduplication, you will need to handle duplicates/edits to existing items manually for now.
25+
NOTE: This tool has basic [deduplication supported](https://github.com/themeldingwars/Firefall-DISASM-Name-Manager#deduplication). However, depending on your data you may still need to handle duplicates/edits to existing items manually.

0 commit comments

Comments
 (0)