# strindex
[](https://pypi.org/project/strindex/)
[](https://pypi.org/project/strindex/)
[](https://github.com/zWolfrost/strindex/releases/latest)
[](LICENSE)
A command line utility to extract and patch strings of various filetypes, with a focus on compatibility and translation.
This utility will allow you to replace strings in supported filetypes with other strings. It's useful to change the text of a program without having to recompile it, for example, to translate a program into another language.
Apart from using offsets to replace strings, there's also an option to use the original string itself to ensure compatibility with different versions of the same program.
There are a lot of features to help with translation, such as spellchecking & filtering strings by length and character set.
The release includes a precompiled version of the program, which ONLY does the patching. If you want to use the other features, you will need to install Python 3.6 or later and the required libraries.
## Supported filetypes
*Support for more types won't be added unless I find some motivation to...*
- PE files (".exe, ".dll"...)
- Gamemaker data files ("data.win")
## Installation
You can install the program with the command `pip install strindex`.
## Usage
You can run the program with the command `strindex <action> <input file(s)> [options]`.
These are the available actions:
- `create`: Create a list of strings from a PE file (a strindex). Use `-c` to create a strindex that uses the original strings as references.
- `patch`: Patch a PE file with a strindex.
- `patch_gui`: Patch a PE file with a strindex using a GUI.
- `update` Update a strindex pointers' with the updated version of a file.
- `filter`: Filter a strindex by detected language, wordlist or length. You can specify those in the strindex settings.
- `delta`: Create a delta file between two strindexes, that only contains the lines of the first strindex missing in the second one.
- `spellcheck`: Spellcheck a strindex. You can specify the target language in the strindex settings as an ISO 639-1 code.
## Usage Examples
- Create a strindex from a PE file:
```sh
strindex create program.exe -o strindex.txt
```
- Patch a PE file with a strindex:
```sh
strindex patch program.exe strindex.txt
```
## Strindex Example
You can find an example of a strindex file and an explanation of its settings [here](strindex_example.txt).
Raw data
{
"_id": null,
"home_page": "https://github.com/zWolfrost/strindex",
"name": "strindex",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "PE strings patching translation",
"author": "zWolfrost",
"author_email": "zwolfrost@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c1/9d/5c83fbc7ba12346994ac4c0e065474bb9a4848a31d442952f5a15a86071a/strindex-3.4.0.tar.gz",
"platform": null,
"description": "# strindex\n[](https://pypi.org/project/strindex/)\n[](https://pypi.org/project/strindex/)\n[](https://github.com/zWolfrost/strindex/releases/latest)\n[](LICENSE)\n\nA command line utility to extract and patch strings of various filetypes, with a focus on compatibility and translation.\n\nThis utility will allow you to replace strings in supported filetypes with other strings. It's useful to change the text of a program without having to recompile it, for example, to translate a program into another language.\n\nApart from using offsets to replace strings, there's also an option to use the original string itself to ensure compatibility with different versions of the same program.\n\nThere are a lot of features to help with translation, such as spellchecking & filtering strings by length and character set.\n\nThe release includes a precompiled version of the program, which ONLY does the patching. If you want to use the other features, you will need to install Python 3.6 or later and the required libraries.\n\n## Supported filetypes\n*Support for more types won't be added unless I find some motivation to...*\n- PE files (\".exe, \".dll\"...)\n- Gamemaker data files (\"data.win\")\n\n## Installation\nYou can install the program with the command `pip install strindex`.\n\n## Usage\nYou can run the program with the command `strindex <action> <input file(s)> [options]`.\n\nThese are the available actions:\n- `create`: Create a list of strings from a PE file (a strindex). Use `-c` to create a strindex that uses the original strings as references.\n- `patch`: Patch a PE file with a strindex.\n- `patch_gui`: Patch a PE file with a strindex using a GUI.\n- `update` Update a strindex pointers' with the updated version of a file.\n- `filter`: Filter a strindex by detected language, wordlist or length. You can specify those in the strindex settings.\n- `delta`: Create a delta file between two strindexes, that only contains the lines of the first strindex missing in the second one.\n- `spellcheck`: Spellcheck a strindex. You can specify the target language in the strindex settings as an ISO 639-1 code.\n\n## Usage Examples\n- Create a strindex from a PE file:\n ```sh\n strindex create program.exe -o strindex.txt\n ```\n- Patch a PE file with a strindex:\n ```sh\n strindex patch program.exe strindex.txt\n ```\n\n## Strindex Example\nYou can find an example of a strindex file and an explanation of its settings [here](strindex_example.txt).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command line utility to extract and patch strings of various filetypes, with a focus on compatibility and translation.",
"version": "3.4.0",
"project_urls": {
"Homepage": "https://github.com/zWolfrost/strindex"
},
"split_keywords": [
"pe",
"strings",
"patching",
"translation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3cdc57663cb060e43878007a82ab986aa74435648a14180caa438ae0353db41",
"md5": "dc8d87bced5d9b0d58f26646602758d7",
"sha256": "6ecbaf62f729dce72e765f127338a119dd25cc7f95c4c04e38fa3774052dd65c"
},
"downloads": -1,
"filename": "strindex-3.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc8d87bced5d9b0d58f26646602758d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23763,
"upload_time": "2024-11-22T21:21:20",
"upload_time_iso_8601": "2024-11-22T21:21:20.993478Z",
"url": "https://files.pythonhosted.org/packages/d3/cd/c57663cb060e43878007a82ab986aa74435648a14180caa438ae0353db41/strindex-3.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c19d5c83fbc7ba12346994ac4c0e065474bb9a4848a31d442952f5a15a86071a",
"md5": "c00ab303f0d721798ba9b70c833eb4fb",
"sha256": "d72f3e811e5162eb8612a2c51490ca15d052aa1813e519581216da2a5c9ce237"
},
"downloads": -1,
"filename": "strindex-3.4.0.tar.gz",
"has_sig": false,
"md5_digest": "c00ab303f0d721798ba9b70c833eb4fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17355,
"upload_time": "2024-11-22T21:21:22",
"upload_time_iso_8601": "2024-11-22T21:21:22.709570Z",
"url": "https://files.pythonhosted.org/packages/c1/9d/5c83fbc7ba12346994ac4c0e065474bb9a4848a31d442952f5a15a86071a/strindex-3.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 21:21:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zWolfrost",
"github_project": "strindex",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "strindex"
}
JSON
