Skip to content

Commit 43b9839

Browse files
robertvokacclaude
andcommitted
Docs: add TODO.md with comprehensive content improvement proposals
Covers 10 areas: missing articles, content improvements on existing pages, new sections to add, structural/navigation issues, consistency fixes, broken links to verify, writing quality, images/media, project page gaps, and potential website features. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 73ed3e6 commit 43b9839

1 file changed

Lines changed: 317 additions & 0 deletions

File tree

TODO.md

Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,317 @@
1+
# TODO — openeggbert.com content improvements
2+
3+
This file tracks proposed improvements to the `src/` content of openeggbert.com.
4+
Items are grouped by area. Within each group, items are roughly priority-ordered (high → low).
5+
6+
---
7+
8+
## 1. Create missing articles (broken link stubs)
9+
10+
These pages are linked from existing content via `Article_does_not_yet_exist_or_link_is_broken`
11+
but have no real article yet.
12+
13+
### Games & companies
14+
- [ ] `src/Blupi/Games/Speedy_Blupi_(Windows)/eGames/index.md` — eGames company (US publisher of Speedy Eggbert)
15+
- [ ] `src/Blupi/Games/Speedy_Eggbert/Dada_Games/index.md` — link exists in breadcrumb of Speedy_Eggbert but directory is missing
16+
- [ ] `src/Blupi/Games/Speedy_Blupi_(Windows)/Sequel/index.md` — article about the concept of sequel
17+
- [ ] `src/Blupi/Games/Speedy_Blupi_(Windows)/Comparison_SB_vs_SE/index.md` — comparison of Speedy Blupi and Speedy Eggbert (referenced from Speedy_Eggbert page)
18+
19+
### People & community
20+
- [ ] `src/Blupi/Community/HMVocaloid/index.md` — started the SB2 decompilation project
21+
- [ ] `src/Blupi/Community/jummy0/index.md` — contributed to sb2-decomp, lost files
22+
- [ ] `src/Blupi/Community/Mathieu_Schroeter/index.md` — exists as directory but needs content check
23+
24+
### Technologies — programming languages
25+
- [ ] `src/Technologies/Programming_languages/C/index.md` — C language (used by Wine)
26+
- [ ] `src/Technologies/Programming_languages/Java/index.md` — Java (used by Sprite Utils)
27+
28+
### Technologies — libraries / frameworks
29+
- [ ] `src/Technologies/Libraries/MonoGame/index.md` — MonoGame (XNA alternative, used by Mobile Eggbert C#)
30+
- [ ] `src/Technologies/Libraries/FNA/index.md` — FNA (XNA alternative)
31+
- [ ] `src/Technologies/Libraries/KNI/index.md` — KNI (MonoGame fork, used for web port)
32+
- [ ] `src/Technologies/Libraries/ILSpy/index.md` — decompiler used for Mobile Eggbert
33+
- [ ] `src/Technologies/Libraries/Ghidra/index.md` — decompiler used for Free Eggbert
34+
- [ ] `src/Technologies/Libraries/IDA/index.md` — decompiler used for Free Eggbert
35+
- [ ] `src/Technologies/Libraries/OpenGL/index.md` — OpenGL (used by EasyGL/MetaGL/CNA)
36+
- [ ] `src/Technologies/Libraries/Vulkan/index.md` — Vulkan (planned CNA backend)
37+
- [ ] `src/Technologies/Libraries/WebGL/index.md` — WebGL
38+
- [ ] `src/Technologies/Libraries/WebGPU/index.md` — WebGPU
39+
- [ ] `src/Technologies/Libraries/LibGDX/index.md` — LibGDX (mentioned in Mobile Eggbert)
40+
- [ ] `src/Technologies/Libraries/TinySoundFont/index.md` — used in Free API for MIDI
41+
42+
### Technologies — tools & applications
43+
- [ ] `src/Technologies/Applications/Audacity/index.md` — audio editor for creating sounds
44+
- [ ] `src/Technologies/Applications/RayDreamStudio/index.md` — 3D tool used to create Speedy Blupi sprites
45+
- [ ] `src/Technologies/Applications/GIMP/index.md`
46+
- [ ] `src/Technologies/Applications/Inkscape/index.md`
47+
- [ ] `src/Technologies/Applications/CLion/index.md` — IDE used by Robert Vokac
48+
- [ ] `src/Technologies/Applications/VisualStudio/index.md` — Visual Studio (used to build Speedy Blupi)
49+
- [ ] `src/Technologies/Applications/WPInternals/index.md` — tool for unlocking Windows Phone bootloader
50+
51+
### Technologies — platforms
52+
- [ ] `src/Technologies/Platforms/iOS/index.md` — mentioned as not supported by Blupi is Back
53+
- [ ] `src/Technologies/Platforms/ReactOS/index.md` — mentioned as alternative to run Speedy Blupi
54+
55+
### Technologies — other
56+
- [ ] `src/Technologies/Other/Emulators/VirtualBox/index.md`
57+
- [ ] `src/Technologies/Other/Emulators/VMware/index.md`
58+
- [ ] `src/Technologies/Other/Emulators/Qemu/index.md`
59+
- [ ] `src/Technologies/Other/Emulators/ExaGear/index.md` — run Speedy Blupi on Android
60+
- [ ] `src/Technologies/Other/Emulators/Winlator/index.md` — run Speedy Blupi on Android
61+
- [ ] `src/Technologies/Other/Emulators/LimboX86/index.md` — x86 PC emulator for Android
62+
- [ ] `src/Technologies/Other/Emulators/index.md` — emulators overview page
63+
- [ ] `src/Technologies/Other/WebAssembly/index.md` — exists but check if has content
64+
- [ ] `src/Technologies/Other/Asm.js/index.md` — exists but check if has content
65+
- [ ] `src/Technologies/Other/OpenSource/index.md` — open-source concept
66+
- [ ] `src/Technologies/Other/ClosedSource/index.md`
67+
- [ ] `src/Technologies/Other/Proprietary/index.md`
68+
- [ ] `src/Technologies/Other/DropInReplacement/index.md`
69+
- [ ] `src/Technologies/Other/XAP/index.md` — XAP file format (Windows Phone executable)
70+
- [ ] `src/Technologies/Other/FluidSynth/index.md` — MIDI player for Linux
71+
72+
### File formats
73+
- [ ] `src/Technologies/FileFormats/index.md` — new section overview
74+
- [ ] `src/Technologies/FileFormats/BMP/index.md` — bitmap format used by Speedy Blupi
75+
- [ ] `src/Technologies/FileFormats/MIDI/index.md` — MIDI music format
76+
- [ ] `src/Technologies/FileFormats/WAV/index.md` — WAV sound format
77+
- [ ] `src/Technologies/FileFormats/OGG/index.md`
78+
- [ ] `src/Technologies/FileFormats/BLP/index.md` — custom Speedy Blupi format (save, user info, demo)
79+
- [ ] `src/Technologies/FileFormats/XCH/index.md` — Speedy Blupi level format
80+
- [ ] `src/Technologies/FileFormats/glTF/index.md` — used as export from MeshCraft
81+
82+
### Dates / years as articles
83+
- [ ] Consider whether year articles (1998, 2001, 2013, ...) should be stub pages or removed in favour of Wikipedia links
84+
85+
---
86+
87+
## 2. Content improvements on existing pages
88+
89+
### `src/index.md` (main page)
90+
- [ ] Introduction text still references `Free Eggbert` with a broken link (`Article_does_not_yet_exist_or_link_is_broken`) — link to `Projects/Free_Eggbert/index.html` instead
91+
- [ ] Add a short description / tagline for each project listed in the infobox
92+
- [ ] Screenshots section only has 2 images — consider adding Galaxy Eggbert screenshot and Mobile Eggbert screenshots
93+
- [ ] Update "Current status: To do" for Free Eggbert if status has changed
94+
95+
### `src/About/Contribute/index.md`
96+
- [ ] "Documentation: openeggbert.com (a MediaWiki-powered encyclopedia)" — the site is no longer MediaWiki; update description
97+
- [ ] Issue tracker link points to GitHub org root, not to specific issue tracker
98+
- [ ] Add link to `src/Projects/` for code contribution context
99+
- [ ] Add section about contributing content to this wiki-style website (src/ markdown files, PR workflow)
100+
101+
### `src/About/Future/index.md`
102+
- [ ] "What programming languages and libraries to use for the next decades" section is now outdated — CNA/SDL 3/C++ choice has already been made; update to reflect current decisions
103+
- [ ] X86S paragraph about Intel cancellation needs date clarification (it says "December 2024" which is now past)
104+
- [ ] Add section about Galaxy Eggbert as the planned 3D remake
105+
106+
### `src/About/Goals/index.md`
107+
- [ ] The TODO code block (Projects A–O) is raw text inside a code fence — convert to a proper table or list with links to project pages
108+
- [ ] Add links to CNA, Free Direct, Free API, Galaxy Eggbert in relevant sections
109+
- [ ] Archive section references `https://archive.openeggbert.com/main` — verify if this URL is correct/active
110+
111+
### `src/About/History/index.md`
112+
- [ ] Very sparse — add more milestones:
113+
- When openeggbert.com domain was purchased (18th June 2024)
114+
- Release of Mobile Eggbert (25th November 2024)
115+
- Galaxy Eggbert first build
116+
- Start of CNA, Free Direct, Free API development
117+
- Start of sharpruntime development
118+
- Nova3D project start
119+
- [ ] "Autumn 2024 - Speedy Blupi for Windows Phone was decompiled" — add exact date (November 23–25, 2024)
120+
- [ ] "playeble" typo → "playable"
121+
122+
### `src/About/Hall_of_Fame/index.md`
123+
- [ ] "MediaWiki" entry is incorrect — the site no longer runs on MediaWiki; remove or update
124+
- [ ] Free Direct and Free Api entries have no description — add short descriptions
125+
- [ ] Add entries for new projects: Galaxy Eggbert, Nova3D, Sharp Runtime, EasyGL, MetaGL, MeshCraft
126+
- [ ] Add entry for SDL 3 (currently only SDL without version)
127+
- [ ] Update CNA entry (now a real project, not just an idea)
128+
- [ ] Add entry for TinySoundFont (used in Free API)
129+
130+
### `src/About/Abbreviations/index.md`
131+
- [ ] Add new abbreviations:
132+
- GE = Galaxy Eggbert
133+
- FD = Free Direct
134+
- FA = Free API (or FAPI)
135+
- CNA = CNA (explain the acronym origin if known)
136+
- SR = Sharp Runtime
137+
138+
### `src/Blupi/Community/Daniel_Roux/index.md`
139+
- [ ] Breadcrumb has a space in path: `Blupi/Community/Daniel Roux/index.html` → should be `Daniel_Roux` (bug)
140+
- [ ] Page has almost no text content beyond the infobox and photos — add biography, list of games he created, links to his projects
141+
142+
### `src/Blupi/Community/Robert_Vokac/index.md`
143+
- [ ] External links section at the bottom is empty — add actual external links
144+
- [ ] Nokia Lumia table: add "OS version" column is already there, but some rows have empty OS field
145+
- [ ] Consider adding section about contributions to Open Eggbert
146+
147+
### `src/Blupi/Community/Mathieu_Schroeter/index.md`
148+
- [ ] Check/add content (maintainer of Planet Blupi open-source release)
149+
150+
### `src/Blupi/Games/Speedy_Eggbert/index.md`
151+
- [ ] `Dada_Games` is listed as a subpage but that directory likely doesn't exist — check and remove if broken
152+
- [ ] Troubleshooting section exists in the file — add actual troubleshooting content
153+
154+
### `src/Blupi/Games/Blupi_is_Back/index.md`
155+
- [ ] "Blupi is Back is a new Blupi game to be released in 20 year" — broken sentence, should say "in 20 years" or similar; actually the game was released in 2024 so rephrase
156+
- [ ] Add description of gameplay, screenshots, and external review links
157+
158+
### `src/Blupi/Games/Planet_Blupi/index.md`
159+
- [ ] Add open-source release information (source code published in 2017 by Epsitec/Mathieu Schroeter)
160+
- [ ] Add GitHub repository link: https://github.com/blupi-games/planetblupi
161+
- [ ] Add download links
162+
163+
### `src/Blupi/Fan_projects/` pages
164+
- [ ] `BlupiEdit/index.md` — add more content (screenshots, download, description)
165+
- [ ] `Eggbert_3/index.md` — check if has content
166+
- [ ] `Tiled-blupi/index.md` — check if has content
167+
- [ ] `X-Edit/index.md` — check if has content
168+
- [ ] `X-Edit-Mapper/index.md` — check if has content
169+
- [ ] `Blupi-Bouncers/index.md` — check if has content
170+
171+
### `src/Projects/Free_Eggbert/index.md`
172+
- [ ] The broken link `[Free Eggbert: ](Article_does_not_yet_exist_or_link_is_broken/index.html)` exists on the main `src/index.md` — should point to `Projects/Free_Eggbert/index.html`
173+
- [ ] Add current GitHub repository link for the main openeggbert fork
174+
- [ ] Add section about the Free Direct and Free API dependency relationship
175+
176+
### `src/Projects/Mobile_Eggbert/index.md`
177+
- [ ] "If the C# version will be kept, then..." — update: clarify current decision (C++ rewrite in progress)
178+
- [ ] Add status update: Android touch controls / scaling fixes as of 2025
179+
180+
### `src/Projects/Sprite_Utils/index.md`
181+
- [ ] "How to use" section still has `CONFIG.DEF` content that looks misplaced (belongs in Speedy Blupi docs, not Sprite Utils)
182+
- [ ] Add GitHub link to the repository prominently in infobox
183+
184+
### `src/Technologies/Libraries/XNA/index.md`
185+
- [ ] Check and expand content about XNA 4.0 and its alternatives
186+
187+
### `src/Technologies/Other/Wine/index.md`
188+
- [ ] Check and expand content
189+
190+
### `src/Technologies/Platforms/Windows_Phone/index.md`
191+
- [ ] Check and expand content (links to hardware, WPInternals, XAP format)
192+
193+
---
194+
195+
## 3. New sections / pages to add
196+
197+
### New top-level section: `src/Projects/Planet_Blupi/` (fork)
198+
- [x] Already created — add more content: how to build, how it differs from the Epsitec open-source release
199+
200+
### New page: `src/Projects/Youtube_Frontend/index.md`
201+
- [ ] Expand existing stub with more detail about how the tool works
202+
203+
### New page: `src/Blupi/Blupi_videos/index.md`
204+
- [ ] List of important Speedy Blupi YouTube videos with links, descriptions
205+
206+
### New page: `src/Blupi/Blupi.com/index.md`
207+
- [ ] History and content of the official blupi.com and blupi.org websites
208+
209+
### New page: `src/Blupi/Images/index.md`
210+
- [ ] Gallery or index of Blupi-related images archived at drive.openeggbert.com
211+
212+
### New section: `src/Technologies/FileFormats/`
213+
- [ ] BMP, MIDI, WAV, BLP, XCH, XAP — see section 1 above
214+
215+
### New section: `src/Technologies/Other/Emulators/`
216+
- [ ] VirtualBox, VMware, QEMU, ExaGear, Winlator, Limbo — see section 1 above
217+
218+
### New page: `src/About/Downloads/index.md`
219+
- [ ] The downloads list currently lives in `src/About/index.md` — move it to a dedicated Downloads page and link from About
220+
221+
### New page: `src/About/FAQ/index.md`
222+
- [ ] Frequently asked questions: Can I play Speedy Blupi on Linux? On Android? What is the difference between Speedy Blupi and Speedy Eggbert? What is Open Eggbert? etc.
223+
224+
### New page: `src/Blupi/Games/Speedy_Blupi_(Windows)/Save_format/index.md`
225+
- [ ] Document the BLP save/user info/demo file format (referenced in Goals as a TODO)
226+
227+
### New page: `src/Blupi/Games/Speedy_Blupi_(Windows)/Music/index.md`
228+
- [ ] Document the MIDI music tracks
229+
230+
### New page: `src/Blupi/Games/Speedy_Blupi_(Windows)/Sounds/index.md`
231+
- [ ] Document the WAV sound effects
232+
233+
### New page: `src/Blupi/Games/Speedy_Blupi_(Windows)/Screens/index.md`
234+
- [ ] Identify all screens (main menu, options, game, score) and their buttons (referenced in Goals)
235+
- [ ] Note: `Screens/index.md` already exists under `Speedy_Blupi_(Windows)` but may be empty or for screenshots only
236+
237+
### New page: `src/Blupi/Games/Speedy_Eggbert/Comparison_SB_SE/index.md`
238+
- [ ] Detailed comparison of Speedy Blupi vs Speedy Eggbert (referenced from Speedy_Eggbert page)
239+
240+
---
241+
242+
## 4. Structural / navigation issues
243+
244+
- [ ] `src/Blupi/Community/Daniel_Roux/index.md` — breadcrumb has space in path (`Daniel Roux`) instead of underscore — needs fix
245+
- [ ] `src/Projects/index.md``Youtube_Frontend` is listed in subpages but is arguably not an active project in the same sense as the games/libraries; consider moving to a separate section or adding a "Tools" section
246+
- [ ] `src/Technologies/index.md` — page body is completely empty (only frontmatter); add at least a short introduction paragraph
247+
- [ ] `src/Blupi/Games/index.md` — check if body content exists; if empty, add introduction
248+
- [ ] `src/Blupi/Fan_projects/index.md` — check if body content exists
249+
- [ ] `src/About/index.md` — Downloads section belongs in a separate dedicated page; the page mixes "About the site" with a big download list
250+
- [ ] `src/Blupi/Games/Speedy_Eggbert/index.md` — subpage `Dada_Games` is listed but that subdirectory probably doesn't exist (Dada Games is under `Speedy_Blupi_(Windows_Phone)`, not `Speedy_Eggbert`) — verify and remove if broken
251+
- [ ] Many `Article_does_not_yet_exist_or_link_is_broken` links for years (1998, 2001, 2013, etc.) — these could simply be removed or replaced with Wikipedia links instead of creating stub articles
252+
253+
---
254+
255+
## 5. Consistency and correctness issues
256+
257+
- [ ] `src/About/Contribute/index.md` says "openeggbert.com (a MediaWiki-powered encyclopedia)" — the site is a custom static site generator, not MediaWiki; update wording
258+
- [ ] `src/Projects/Mobile_Eggbert/index.md` "Cancelled projects" now describes them as cancelled but the KNI Web port was working — already partially fixed in Projects/index.md but the Mobile Eggbert page itself still has outdated info
259+
- [ ] `src/Blupi/Games/Blupi_is_Back/index.md` — "to be released in 20 year" is a broken sentence; the game was released on 23rd July 2024, fix the sentence
260+
- [ ] `src/Projects/Sprite_Utils/index.md` — "How to use" section references `CONFIG.DEF` and Speedy Blupi game settings; this content seems to belong in `Speedy_Blupi_(Windows)/CONFIG.DEF/index.md`, not in Sprite_Utils
261+
- [ ] `src/About/Hall_of_Fame/index.md` — "MediaWiki" listed as 2-star item "software which openeggbert runs on" — this is wrong; update
262+
- [ ] `src/Projects/Free_Eggbert/index.md` links to `Technologies/Other/Reverse_engineering/index.html` with a relative path that looks correct, but verify all relative paths in project pages are consistent
263+
- [ ] `src/Blupi/Games/Speedy_Blupi_(Windows_Phone)/Dada_Games/index.md` — check if this subpage has content
264+
265+
---
266+
267+
## 6. Links and references to verify / fix
268+
269+
- [ ] `src/About/Goals/index.md` references `https://archive.openeggbert.com/main` — verify this URL is correct
270+
- [ ] `src/About/Useful_websites/index.md` has many `[?](?)` placeholder rows (numbers 12, 14–18, 21–23, 25–29, 32, 34–37, 40–42, 46, 56, 63) — fill in or remove
271+
- [ ] `src/Blupi/Epsitec/index.md` — verify content and links
272+
- [ ] `src/Blupi/index.md` — X (Twitter) link for `@BlupiGames` is struck through (deleted account?) — verify and update or remove
273+
- [ ] `src/Blupi/Community/Daniel_Roux/index.md` — email address `danielroux33@gmail.com` is personal; consider whether it should be publicly listed
274+
- [ ] Hall of Fame links for `Speedy-Eggbert-2-Source-Code-Decomp` use `<nowiki>` tag which is MediaWiki syntax — convert to plain Markdown link
275+
276+
---
277+
278+
## 7. Quality of writing / presentation
279+
280+
- [ ] Many pages use `<br>` for paragraph separation instead of blank lines — convert to proper Markdown paragraphs where possible
281+
- [ ] Inconsistent use of `**bold**` vs `<strong>` across pages — standardize to Markdown bold
282+
- [ ] `src/Projects/Sprite_Utils/index.md` example table row data is still compressed on one long line (line 81 content was removed but verify cleanup is complete)
283+
- [ ] `src/About/Goals/Sound/index.md` — the content is AI-generated generic advice (numbered steps, tool suggestions); consider replacing with more specific information about the actual sounds in Speedy Blupi and the specific workflow used/planned
284+
- [ ] `src/Projects/Mobile_Eggbert/index.md` — "Reasons to Rewrite" and "Reasons not to Rewrite" sections are now historical (decision already made); consider converting to a past-tense note or removing
285+
- [ ] `src/Blupi/Games/Speedy_Blupi_(Windows)/index.md` — verify content is comprehensive and up-to-date
286+
287+
---
288+
289+
## 8. Images and media
290+
291+
- [ ] Main page has only 2 screenshots — add Galaxy Eggbert, Nova3D demo, MeshCraft screenshot
292+
- [ ] `src/About/Hall_of_Fame/star.jpg` is used inline with `<img>` tags; the stars approach is functional but brittle — consider using Unicode ★ characters instead for simpler maintenance
293+
- [ ] `src/Blupi/Community/Daniel_Roux/index.md` — photos are hotlinked from `smaky.ch`; consider mirroring to `drive.openeggbert.com` in case the source goes down
294+
- [ ] Most project pages (CNA, Free Direct, Free API, etc.) have no screenshots — add screenshots or diagrams where appropriate
295+
296+
---
297+
298+
## 9. Projects section — remaining gaps
299+
300+
- [ ] `src/Projects/Sharp_Runtime/index.md` — add implementation status table (which System::* classes are done)
301+
- [ ] `src/Projects/Nova3D/index.md` — add screenshot of BlupiDemo sample running
302+
- [ ] `src/Projects/Galaxy_Eggbert/index.md` — add screenshot, add World Format link (there's a `World Format.md` in the repo)
303+
- [ ] `src/Projects/MeshCraft/index.md` — add screenshot (`mesh_craft_screenshot.png` exists in the repo)
304+
- [ ] `src/Projects/Planet_Blupi/index.md` — add build instructions specific to the OE fork
305+
- [ ] `src/Projects/Galaxy_Eggbert/index.md` — add link to world format specification
306+
- [ ] All new project pages are missing `tags:` frontmatter — add relevant tags once a tag taxonomy is defined
307+
308+
---
309+
310+
## 10. Potential new features for the website itself
311+
312+
- [ ] Add a `src/Changelog/index.md` page tracking website content updates
313+
- [ ] Add a `src/Sitemap/index.md` or improve the existing `tree.html` with descriptions
314+
- [ ] Consider adding a `src/Search/index.md` or static search integration
315+
- [ ] Tags system (`tags.html`) — ensure all pages have relevant tags assigned; many pages have no `tags:` key at all
316+
- [ ] Add a dedicated `src/Downloads/index.md` aggregating all download links from across the site
317+
- [ ] `src/About/Useful_websites/index.md` — the WARC archive download links should be updated for all new archived sites

0 commit comments

Comments
 (0)