Skip to content

Latest commit

 

History

History
137 lines (110 loc) · 3.57 KB

README.md

File metadata and controls

137 lines (110 loc) · 3.57 KB
Raw

background-toy

Hi! I'm your virtual desktop friend. (for mac)

Overview

This is a desktop pet program, built with Swift and can be run and built using Xcode. It can be a virtual friend that occasionally interacts with you.

Screenshot

.

Custom

How to modify json file

You can find the Json file using the Finder. The addition of a Json file editor in the future is uncertain.

Mac OS applications are essentially folders, and you can access their contents by right-clicking on the application and selecting 'View Package Contents'. The path ./Contents/Resources/ holds Json files, which you can edit.

To customize, simply follow the provided guide.

Custom Animation

You can customize the animation by editing the animation.json file. You just need to update the spriteFolderPath with the path to the folder that holds your animation images. Ensure that you follow these guidelines:

Animation image names should be in the format of {animation name}_{index}.png. You need to have at least one image for each idle, walk, grab, touch, and playing cursor animation.

Here's a sample animation.json file:

{
    "spriteFolderPath": "default",
    "clips": {
        "idle": {
            "count": 3,
            "playType": "pingpong"
        },
        "walk": {
            "count": 7,
            "playType": "restart"
        },
        "grab": {
            "count": 3,
            "playType": "pingpong"
        },
        "touch": {
            "count": 2,
            "playType": "restart"
        },
        "playingcursor": {
            "count": 6,
            "playType": "restart"
        }
    }
}

playType refers to how the animation is played, either "pingpong" (play backwards when the animation ends) or "restart" (restart when the animation ends).

Custom Macro

You can set custom macros by editing the macro.json file. The macros can execute processes, open web URLs, and print chat messages.

Here's a sample macro.json file:

{
    "test1": [
        {
            "type": "process",
            "payload": "/Applications/Discord.app"
        },
        {
            "type": "web",
            "payload": "https://www.google.com/"
        },
        {
            "type": "chat",
            "payload": "Hey! Let's play game."
        }
    ],
    "test2": [
        {
            "type": "web",
            "payload": "https://www.naver.com/"
        }
    ]
}

Custom Chat

You can set custom chat messages by editing the chat.json file. The chat messages are based on time and classified into morning, lunch, afternoon, evening, and night. You can add as many lines as you wish.

Here's a sample chat.json file:

{
    "morning" : [
        "morning data 1",
        "morning data 2"
    ],
    "lunch" : [
        "launch data 1",
        "launch data 2"
    ],
    "afternoon" : [
        "afternoon data 1",
        "afternoon data 2"
    ],
    "evening" : [
        "evening data 1",
        "evening data 2"
    ],
    "night" : [
        "night data 1",
        "night data 2"
    ]
}

Conclusion

This desktop pet program built with Swift is a fun and interactive tool for users. It offers various features including macro execution, making it a well-rounded and customizable experience. The ability to change the animation, macro commands, and chat messages allows users to make the program their own. Whether it be a helpful reminder or a virtual friend, this program is sure to bring a touch of enjoyment to the user's desktop.