What is localconfig.json? Meaning, uses and a safety warning
localconfig.json is not one file. It is a name that different programs use for their own settings file, so the right copy always comes from the program that needs it. We do not host it.
The short answer
- It is plain text. A
.jsonfile holds settings in a simple key and value format. You can open it in any text editor. - There is no standard version. A
localconfig.jsonfrom one program will not work in another, because each program decides which settings it reads. - If a game or an app told you to download it, read the warning below before you do.
A real example: MapStore2
The best-documented localConfig.json belongs to MapStore2, an open-source web mapping application. In MapStore2 it sits in the configs folder and holds the application’s main settings. A different file can be loaded by adding a localConfig parameter to the address, for example ?localConfig=myConfig. Its documentation lists settings such as:
proxyUrl: the proxy address, plus auseCORSlist of services that do not need the proxy.geoStoreUrlandprintUrl: the addresses of the services the app talks to.plugins: which plugins load in desktop, mobile and embedded modes.projectionDefs: custom coordinate systems.bingApiKeyandmapquestApiKey: API keys. Treat these like passwords.
Other projects use similar names, such as local-config.json or local.proxy.config.json. Check the project’s own documentation to see what its file contains.
If you found it in a game video: be careful
Many searches for this name come from videos and posts that offer a localconfig.json as a cheat or “config” for a mobile game, usually with a link to a file-sharing site or a Discord server. We do not host such files and we do not link to them. Reasons to stay away:
- The download can be malware. These files are usually shared through unknown file-hosting links, often together with a modified game app. A file from a stranger can be a trap even when the name looks harmless.
- Your game account can be banned. Online games prohibit cheating tools and ban accounts that use them. Read the game’s own rules.
- You may be asked to give access you should not give. Never hand over your game login, phone permissions, or a one-time code to get a file.
If someone already gave you a file
The JSON file is only text, so you can look at it safely before you do anything else. Open it in a text editor, not in an app. Warning signs:
- Web addresses you do not recognise. A settings file that points your connection at a server run by a stranger (this is what “proxy” files in game communities are usually described as doing) sends your traffic through that server.
- Anything that looks like a login. Words such as
token,password,keyorcookiewith a long value. - Instructions that include installing another app. The text file cannot run, but the app or installer that comes with it can. Do not install apps from links in videos or chat groups, and do not give an unknown app broad phone permissions.
If you already installed something and your phone behaves strangely, remove the app, change your game and email passwords from a different device, and run your phone’s built-in security scan.
If you have a real localconfig.json
- Check that it is valid. Paste it into the JSON formatter. It runs in your browser, so the text is not sent to us. A missing comma or quote is the most common problem.
- Never share the keys inside it. If it has an API key, password or token, remove those values before you post it anywhere.
- Convert it if you need to. The JSON to TypeScript and JSON to CSV tools can help.
- Need a config for a common tool? See the generators for tsconfig.json, package.json, nginx reverse proxy and the full list.
Questions people ask
- Where can I download localconfig.json?
- There is no single download. Get it from the documentation or the source of the program that asks for it. Do not use file-sharing links from videos or chat groups.
- Is localconfig.json safe?
- A JSON file is only text, so the file itself cannot run. The danger is where you get it from and what you are told to do with it, such as installing a modified app. A file from an unknown source should be treated as untrusted.
- Does it work as a proxy file?
- Only if the program that reads it has a proxy setting. In MapStore2, for example,
proxyUrlis the address of the proxy the application uses. The file does not turn a phone or a game into a proxy by itself. - Why does the name sometimes have capital letters?
- The name is just a convention. Some projects write
localConfig.json, otherslocal-config.json. Use exactly the spelling the program documents. - I have localconfig (2).json. What does the (2) mean?
- Your browser added it because a file with that name was already in the folder. Rename it back to the name the program expects.