Starfield External Map Helper

Current State of W.I.P:

2.1.2024: I'm currently somewhat busy helping to improve the UESP-Wiki, so don't expect any major updates during the next 4-8 weeks. I will however release smaller polishing updates on a 1-2 weekly frequency. A difficulty overlay to have a quick fly over system specific difficulties. Adding "real Star names" as toggleable option. The system template, which might end up being a full fledged auto build extension for systems. See the back up for revision 1 which allowed you to build your own stars.

31.1.2024: a quote from the new 0.3 release changelog:

and now for the major bomb drop:

- the whole "system mini journal aspect" has been revamped. there is now a dedicated system "journal" if you press the "s"(system) or "c"(codex). the structure might be intially confusing, because you will be presented with a 240 elements grid. each of the elements has a "button" like shape and a text input area. the text input area is supposed to act like a "naming field", so, for example, you could write a system name into it. if you then click the adjacent button, it will expand the "journal" underneath which will give you access to 12 text fields plus 12 adjacent image spaces. the idea here is simple: combine text and images you make in game

technically that means what I present you with here, is an interactable in game "Wikipedia" or "Codex" or whatever name you wanna give it. adding images is as easy as to make a Steam screenshot and then use the Steam overlay to catch the image link and put it into your journal's URL imagelink section. of course all the new features are fully saved to local storage, and can be exported to an external .json, so to say "saved" as a game would be saved. but mind though, given the sheer quantitie of entries this new addition is potentially going to add to local storage, I wouldn't rely on LS at all. from here now it's more like a "short time" saving/back-up instance depending on the number of entries. you will most certainly lose content if you close the application without properly saving(exporting) to .json

and if that wasn't enough, as already mentioned, there are two instances of that new journal. one is a"system" journal, the other is meant to be used as "fauna/flora codex"., but of course you are free to use those journals for whatever you like. i'd love to see some of you guys sharing .json exports online for others to import. but mind though, the codex, for now, is basically just a copy aste variant of the system journal, because I didn't found the time and enough reasons to customize it apart from the system journal. but that doesn't mean it is not fully intact, it only means it will be subject to strong visual variation in future updates

20.3.2024: With version 0.4 released I guess we're closing in for final release. There's not much left to do aside from integration with the game, and better catching of image files from Steam. But that's going to be made real in future updates if we have full access to developing tool, and a bigger community contributing ideas. I recon some of the changes since version 0.2 are not anyone's cup of tea. But always remember, the primary reason why I'm doing things is, it has to work for me, in my game, and if it doesn't then I will remove features, bring back features previously removed, or change diecisions I made with past updates. 

I'm moving on while I'm playing the game and sometimes things that were good before aren't good anymore and vice versa. In myopinion it is still a functional and great asset of help, and a QoL utility to make things more convenient.

What this?

A general purpose .html based offline application, to improve general accessibility, provide wiki based information, and allow for a wide variety of additional features not found, but strongly needed in the game.

Care to explain details?

1. a 2D static starmap of all settled systems you can interact with
2. 2 extended "journals" for system and/or flora/fauna documentation
3. visualize discovered, surveyed, and outpost state
4. a resource wheel showing general resource availability in every system
5. a general purpose global journal
6. a difficulty overlay on keypress
7. direct links to the Starfield Wiki('s) through various means
8. direct access to local maps and 8 different web based wiki/infobase sources
9. direct access to the Starfield Community Patch website to, for example, report bugs
10. map state and journals will be saved in local browser storage, but can also be exported to a .json(download folder)
11. compatible with any browser, including the Steam browser
12. real time clock display
13. a fully integrated music player to dynamically choose sources to play music from the internet or your desktop
14. direct wiki links to real life star information
15. read out various info directly from star icon labels, or hovering over some of the additional icon components
15. source available by default and free to edit by anyone

Why and how to use?

I can not answer the why for you, but you can use it in any browser. I personally use it in both, the Steam Browser, and on my second computer with Chrome, where on my Steam browser I'm actually using the global journal only, and I control my second computer with "Mouse Without Borders". You can use it on a second monitor, or you can use it just on one computer, with one monitor and Alt-Tab'ing out of the game. If you are used to Elite Dangerous gameplay then you'll certainly have a second computer and/or monitor, which is the recommended way of using this Helper. 

How to I save my Data?

Your entries will be saved to local browser storage automatically on various occasions, like opening/closing elements, interacting with text fields, clicking buttons etc. But notice that local storage is limited in space(about 20mb depending on the browser), and that version 0.3 onward is making extensive use of that space. So it's very likely you are prone to data loss if you do not use the second way of saving your data, and that is...

Exporting to .json: Basically what that means is, you should treat this "Helper" like it is a game you play, and like in every game you would need to save your game in order to not lose progress. There are currently four files to be saved(main page, general journal, system journal, survey codex), and they will all be placed in your download folder when you save your "game". The download folder is preset by the browser, and the only space that is not restricted by security if you try to mimic saving to file behaviour in a browser environment. However, you can import(load) the files from any space you want.

I'm going to start working on a single file save once the utility goes final.

Will this be worked on and improved?

Everything has been implemented so far with the exception of the individual system pages. The reason for that was easy: while those system pages were visually appeasing, their informative value was sub 0 because all they actually did was linking you to Wiki pages by clicking on its celestial bodies. In the long run I did not see the value of upholding this kind of "out of proportion" effort vs "suboptimal use". And yes, deficient user created pages, like a solid number of users proposed to work on, never happened. So that's also a major reason for dropping the system pages. I didn't really had a need for them to begin with, as the final goal was always to create something like a "Captain's Log" kind of utility.

Does this interact with the game?

No, and that's intentionally, hence the title "Helper". The decision for this has been made for security reasons, and because I won't do features I could implemend into the game directly. Implementing web access into flash elements would be a way to longetive and tedious task, hence why it makes sense to do it externally with a .html based app. I intentionally wanted something outside of the game I can interact with to document my life as a Starborn, or whatever way I choose. The settled systems should have internet, right? So it does make sense to include it into the game. This helper just does it in a very convenient and direct way.

I'm not sure if and how this could be subject to change. But I am open to suggestions, as I would love to use this utility for anyone to contribute to a online present web "infospace", where everyone is free of anything to add they've dcoumented in their journey.

How to install?

There is no install. Just unzip and place where ever you want. I recon you are able to create a desktop link?

Can I debug?

Yes, you actually can. Using Notepad++ you can edit every single part of this utility. .html and java code inside .html's is compiled at runtime inside the browser, so all files are entirely sourced. You just have to read it and edit to your wishes. Also, every browser has a debug mode which you can enable when pressing "F12". Inside the debug mode you will also have access to local storage, performance data, and various other strcutural data.

Can I contribute?

Yes. Feel free to do so. Any help, specially in regard to building system pages is very well appreciated. I'm going to provide a system template .html during the next days, so you can easily build your own by simply editing vars and links. I'm probably going to write a tutorial in this regard. You can also just fork on Github, or ask for access to the Github presence, to upload your own contributions. I'm all open for input specially in regard to internet code, and how to get around cross policy security. I would also love to see recommendations which other features and web sides you'd love to see integrated.

The options with .html are sheer endless. It's a great little asset and extremely "noob" friendly. Your level of skill does not matter at all. But notice I'm not really a fan of "big words" without the comprehension that some effort has to be forwarded on your own, if you so to speak "want to join the team". There are a lot of people promising to help, but in 99% of all cases they don't once they realize how much work is involved in such a big project.

Do you have other background in regard to space mod creation stuff?

Yes. See the Static Galaxy Editor for Stellaris. Something similar could be implemented for Starfield. There are also resources available for Galactic Civilization III.

I want to report a bug!

Use the comment section.