MSRevive/MasterSwordRebirth

Replace custom MS types with STL types

Open

#179 opened on Feb 25, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)C++ (16 forks)auto 404
enhancement 🔧good first issuehelp wantedmed priority

Repository metrics

Stars
 (20 stars)
PR merge metrics
 (PR metrics pending)

Description

The types that need replacing:

  • msstring - It's a C style fixed string type. Replacing it with std::string isn't advised since it's dynamically allocated. It'll probably be best to make our fix fixed string inherited from std::basic_string or use a library like this that contains a fixed string.
  • msvariant - A variant variable that fits a c string, int, or float
  • msstring_ref - Type defined as a const char*
  • mslist - a linked list list that is used a vector throughout the code as well. Should be replaced with a std::vector or std::list depending on what should be used there.
  • string_i - In debug mode, a normal string. In release mode its created within the engine and released each level
  • msnew - Should probably be replaced with just new.

This should be done after angelscript is embedded.

Contributor guide

Research direction
Examine each custom type (msstring, msvariant, mslist, msnew) and understand its usage. For msstring, consider using a fixed string implementation like boost::static string or a custom fixed string derived from std::basic string. For msvariant, replace with std::variant. For mslist, decide between std::vector for contiguous storage or std::list for linked list semantics based on actual usage patterns. For msnew, replace with standard 'new' or use smart pointers. Ensure no regressions by running tests after each replacement.
Tech stack
cpp
Domain
game dev
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65