Add a default way of serializing components
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 202
- Forks
- 22
- Avg merge
- 6h 8m
- Merged PRs (30d)
- 7
Description
Currently, if we want to add a new component to Hypermine, boilerplate code has to be added to many different places in the codebase to allow data about this component to be transferred between the server and the client, along with additional boilerplate code to allow saving and loading.
When we start supporting a greater number of components, we should consider how to streamline the process of creating new ones, as this would make it less difficult for people less familiar with the codebase to add features.
One open design problem is how to serialize these components for saving, since naively relying on defaults would likely prevent save files from being compatible between versions of Hypermine.
As of June 2024, we probably need more components in place before we have enough information on how to perform such an abstraction.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named in the issue. Begin by tracing how components are currently transferred between the server and client and how they are saved and loaded, then define a version-compatible default serialization approach. Done means reducing repeated component boilerplate without making save files incompatible across Hypermine versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100