Special K - The Official Wiki

2024-06-01: Blog Galore!

For when you repurpose a Wiki.js site into a blogging platform

Let there be light! (... four years later)

Written by Aemony

This is actually an old proof of concept "blog post" from back in 2020 (specifically November 21) that was used to test and validate the feasability to use the wiki platform (Wiki.JS) as some form of basic "blog" platform on top of its primary intended use case as a pure documentation/wiki site.

It never actually gained any momentum at the time, and was somehow forgotten about over the years as a result, though for us that are administrators of the wiki, a link to it was always present at the very bottom of the sidebar.

Hopefully we'll see more use of this blog in 2024 and onwards! 😄

Trello

In a similar fashion, we actually also have a public Trello board that's been used over the years to have some form of "planned feature" tracking. It has seen some more use, but have also occasionally gone outdated for a few months as the team forget that it exists and implement a lot of changes or features tracked on the Trello in a short duration of time.

I guess that is just what happens when you don't use tools very often — you eventually forget they exist, and end up rediscovering them months or even years later down the line.

Backend infrastructure

In late 2023 our backend infrastructure that's primarily used to cache and facilitate achievement comparisons across Steam friends for those with public Steam profiles, saw a major rewrite by me on pretty much all accounts.

The original code used basic files(!) to emulate a sort of cached database... The clean-up of these regular files also wasn't working properly which was kind of fun (not) when I discovered it... I did not know that Linux's command to remove files actually have a hard limit of how many files it can process (somewhere in the tens of thousands of files, I think it might've been), but now I know... 😅 But yeah... when I discovered this issue, it was because the backend server was out of disk space as it turned out we had millions of old outdated cached files of various public data points just laying around, gathering dust.

On top of that, the main "for fun" frontend webpage was quite unoptimized and slow to process and load in for all devices. In fact, on every(!) visit/page load, the full page was being processed as nothing was being cached, and all cover images was also set up to be downloaded by the client on load... So visiting the page could end up with half a minute of initial page load, followed by some 80-100 MBs of images being downloaded in the background just to cache all of the game covers on the user's device...

So anyway, across 2023, and especially in late 2023, the backend infrastructure saw major rewrites across the board to solve the various issues it experienced and facilitate future development and features:

After having worked on the backend, and gotten a better understanding of what was going on, and what we could do with it, additional functionality to allow for the submission of more automatic anonymized diagonstics and telemetry was added to it, and the Special K Injection Frontend (SKIF) was also updated to make this an opt-out option for the user. If/when Special K ever gets updated to make use of these new endpoints, we should be able to create a new and improved hourly real-time online player count of Special K users.

Currently the "online player count" is not actually accurate at all as it works by effectively counting the number of unique API requests the backend have had within the recent hour or so, something that only applies to a specific subset that plays a Steam game, have our Steam enhancement features enabled, and have not already made a similar request recently (as Special K also caches stuff locally).

I think having a better and more accurate player count would be quite fun, and might make for a fun counterpart to Special K's current "online Steam players" visible in the in-game control panel right now.

Quite a lot on the topic of the player count, but that's honestly the most fun aspect of it for me, though in practice the most use of the new backend endpoints will be for stuff like automatic telemetry/diagnostics gathering, e.g. identify games where Special K crashes the most in, or where it hits a specific rare ASSERT, and all that stuff that allows us to identify and focus the development on areas currently not covered or reported by our community.

But anyway, a bit of a rambling, but yeah, a major rewrite for both the frontend and backend, while still ensuring compatibility across all Special K versions that have ever interfaced with the backend infrastructure. No code was changed in Special K itself once the work had been done. 😃

Right now none of the new backend stuff is actually being used by Special K, so as of May 2024 no telemetry or diagnostics are collected, though the underlying infrastructure is more than ready for it, and we might hopefully see some expanded use of it throughout 2024.

For those of you who would like to opt-out of any (eventual) automatic diagnostics gathering, see our Privacy Policy.