Skip to content

Store user data as local config binary#15

Merged
finityfly merged 2 commits intomainfrom
feat-userdata
Jul 8, 2025
Merged

Store user data as local config binary#15
finityfly merged 2 commits intomainfrom
feat-userdata

Conversation

@finityfly
Copy link
Owner

@finityfly finityfly commented Jul 8, 2025

This pull request introduces several enhancements to the clitris project, including improvements to installation methods, better user configuration handling, and updates to the README.md documentation. The most significant changes involve adding save and load functionality for user settings, updating installation scripts for Linux/macOS, and expanding the documentation to include uninstall instructions.

Installation and Documentation Updates:

  • Improved installation instructions in README.md: The "From Source" section was replaced with separate instructions for Linux/macOS, and a new "Uninstall" section was added for both Homebrew and Linux/macOS users. [1] [2] [3]
  • Updated install.sh: The script now includes error handling, clones the repository, and installs the binary to /usr/local/bin/clitris.

User Configuration Management:

  • Added Settings::saveConfig and Settings::loadConfig methods: These methods allow saving and loading user settings to/from a binary file, enabling persistent configuration across sessions. [1] [2]
  • Introduced Settings::getUserDataPath: This method determines the appropriate directory for storing user data based on the operating system. [1] [2]

Code Integration:

  • Loaded user configuration in main.cpp: The Settings::loadConfig method is called at the start of the program to initialize settings from saved data.

These changes collectively enhance usability, streamline installation, and ensure user settings persist across sessions.

Summary by CodeRabbit

  • New Features

    • Added support for saving and loading user settings to a persistent configuration file, ensuring your preferences are retained between sessions.
  • Documentation

    • Updated installation and build instructions for Linux/macOS, including a new install script and improved Homebrew guidance.
    • Added uninstall instructions and revised the table of contents for easier navigation.

@finityfly finityfly merged commit 71e4455 into main Jul 8, 2025
1 check was pending
@coderabbitai
Copy link

coderabbitai bot commented Jul 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce persistent configuration support by adding methods to save and load user settings to a binary file in a user data directory. The installation instructions and script have been updated for clarity and automation, including a new uninstall section. The application now loads configuration on startup and saves it after changes.

Changes

File(s) Change Summary
README.md Revised and expanded installation, build, and uninstall instructions; updated table of contents.
install.sh Overhauled to clone repository and move binary; now assumes prebuilt binary in repo and adds error handling.
include/Settings.h Added static method declarations: saveConfig(), loadConfig(), getUserDataPath(), loadConfig().
src/Settings.cpp Implemented persistent config: added saveConfig(), loadConfig(), getUserDataPath(); modified configure() to save.
src/main.cpp Loads configuration at startup by calling settings.loadConfig() after instantiation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Main
    participant Settings

    User->>Main: Start application
    Main->>Settings: loadConfig()
    Settings->>Settings: Read settings.bin (create if missing)
    Main->>User: Show menu / game

    User->>Main: Open settings
    Main->>Settings: configure()
    Settings->>User: Show settings window
    User->>Settings: Change settings
    Settings->>Settings: saveConfig()
Loading

Poem

In a warren of code, a rabbit did write,
Saving settings with joy, from morning to night.
Now configs persist, through shutdown and load,
With install scripts clear, and uninstall showed.
Hippity-hop, with a binary hop—
Your preferences are safe, from start to stop! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbac269 and 8424395.

📒 Files selected for processing (5)
  • README.md (3 hunks)
  • include/Settings.h (2 hunks)
  • install.sh (1 hunks)
  • src/Settings.cpp (2 hunks)
  • src/main.cpp (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@finityfly finityfly deleted the feat-userdata branch July 9, 2025 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant