FilipeTessaro - Codexcraft: Codex, Tutorials, Notices and 3D Inspection for Multiplayer (C++/BP)

Codexcraft is what the player knows and how the game teaches it, for Unreal Engine 5.6, 5.7 and 5.8, written in C++ with every function open to Blueprint. Four components: a codex, tutorials, notices and 3D inspection. Each one works alone, and when they sit on the same PlayerState they talk to each other.

Built for multiplayer: the server decides, each player sees their own. Tested with 4 clients at 150 ms and 5% packet loss, on a listen server and a dedicated server, with 0 failures.

Codex.

  • Entries in a Data Table, unlocked on the server, per player or shared by the team.

  • Sections that open later in the same entry: meet the wolf, then learn its habits, then its weakness.

  • Entries that bring others with them, closed slots with a hint, read marks, progress per category.

  • A screen with tabs, search, an unread filter and three orders.

  • A picture, a video on a loop or a voice line with its words on screen, on any entry.

  • An entry about an object has Examine: the inspection opens again from the codex, any time.

Notices.

  • Channels with four queue modes: queue, stack, replace, or drop when busy.

  • Priority that cuts in front and gives back the time that was left.

  • The same notice twice becomes x2. Pause them during a cutscene.

  • From the server to one player, to everyone or to a team.

Tutorials.

  • Started by an event, by a place the player walks into, or by a rule about the game: health under half, an actor tag, entries the player knows. Write your own rules in Blueprint.

  • Steps close on events with a count, on a rule, on a timer, on Continue, or on the key itself: "Press {Action:Jump} to jump" ends when the player jumps, with no code.

  • A step shows as a card in the corner or as a box in the middle of the screen, with a big picture or a video, that can pause a single player game.

  • A hint can cut in front of a running tutorial, which then comes back at the same step, and a repeatable hint can wait a set time before it comes back.

  • What the player already did is not asked again, a finished tutorial never comes back in a later session, and a stuck player gets a reminder.

  • A step can point at an actor (it glows and gets a marker, or an arrow at the screen edge) or frame a part of the UI.

Places. A trigger volume in the level sends a notice, unlocks an entry, starts a tutorial or reports an event when a player walks in, once or every time, with nothing to script. "Inside the area" is also a tutorial rule.

3D inspection.

  • Any static or skeletal mesh on screen, to turn and zoom with the mouse, the keys or both sticks.

  • Details to find by turning the object: a point shows once its side faces the camera, and finding it can open a codex section or report a tutorial event.

  • Documents page by page, a reader mode with big letters, and a voice line with its words on screen.

  • A video in place of the model, for a tape or a screen.

  • Opening an object puts its entry in the codex, and reading a page can open a section.

Keys in texts. Write {Action:Jump} in any text and the player sees the key bound to that action right now, on the device in use, rebinds included. It switches the moment the gamepad is touched. Xbox and PlayStation icons are included.

Common UI. The codex and the inspection come as Common UI screens too, ready for your menu stack: they take the input as a menu, give the focus to the right widget and go back on Back. The plugin's own screens work without Common UI. The demo has a map with both on a Common UI stack.

Languages. Every text of the plugin and the demo goes through Unreal's localization, with English, Portuguese and Spanish included and the gather configs in the plugin. Checked in a Shipping build.

Save. Personal codex, team codex and tutorial progress are saved in the plugin's own slot, or handed to your save system as bytes.

Blueprint. 453 functions, events and fields, checked by reflection. Hooks to say no: Can Client Unlock, Filter Notice, Can Start Tutorial, Can Open Inspection. Custom data and tags on every row.

Included: 17 Widget Blueprints for the screens (replace the look, keep the logic), a demo level with a third person character, pads for every feature, stands to inspect, a trigger volume, and a manual.

Good to know. It enables the Enhanced Input and Common UI plugins. Videos play through the engine's Media Framework, with no sound of their own. Windows only.

Documentation: https://apps.tessaroapps.com/codexcraft/docs/

Support: contato@tessaroapps.com