(Neko)

A Mac OS X port of the Neko program written in Objective-C.

Installation

Copy Neko app in Applications folder, launch it
This program now shows up in the dock like a proper Mac app! You can:

• Use the menu bar to quit or change characters
• Right-click on the cat to open the quick quit menu
• Use standard macOS app controls (⌘Q to quit)

Building from Source

Requirements

• macOS 10.15+
• Xcode 12+ or Command Line Tools for Xcode
• Git

Method 1: Using Xcode (Recommended)

1. Clone this repository:

   git clone https://github.com/jamesfishwick/neko-mac.git
   cd neko-mac

2. Open the project in Xcode:

   open Neko.xcodeproj

3. Important: You need to manually add the new AppDelegate files to the Xcode project:

   • In Xcode, right-click on the project
   • Select "Add Files to Neko"
   • Add src/NekoAppDelegate.h and src/NekoAppDelegate.m

4. Build and run (⌘R)

Method 2: Command Line Build (Quick Testing)

For quick testing with the new dock icon features:

# Clone and navigate
git clone https://github.com/jamesfishwick/neko-mac.git
cd neko-mac

# Use the provided build script
chmod +x build.sh
./build.sh

# Run the test build
./neko_with_dock

Method 3: Manual Compilation

# Compile all source files manually
clang -framework Cocoa \
      -fno-objc-arc \
      -o neko \
      src/main.m \
      src/MyPanel.m \
      src/MyView.m \
      src/NekoAppDelegate.m

# Run it
./neko

Troubleshooting

• Missing dock icon: Make sure NekoAppDelegate files are included in the build
• Compile errors: Ensure you're using -fno-objc-arc (this project uses manual memory management)
• Resource errors: GIF animations are loaded from the Resources/ folder

Usage

Command Line Options

Launch from terminal with character options:

/Applications/Neko.app/Contents/MacOS/Neko -dog

Available options:

• -neko Use neko (cat) character (default)
• -dog Use dog character
• -sakura Use sakura character
• -tomoyo Use tomoyo character
• -bsd Use BSD daemon character
• -tora Use tora character
• -buddy Use buddy character
• -h Show help message

App Controls

Once running, you can control Neko through:

Menu Bar:

• Neko Menu: About, Preferences, Hide/Show, Quit (⌘Q)
• Character Menu: Switch between all 7 characters on the fly
• Window Menu: Standard window controls

Right-Click Menu:

• Right-click on the cat for quick quit access

Keyboard Shortcuts:

• ⌘Q - Quit
• ⌘H - Hide application
• ⌘M - Minimize window

Contributing

This project uses GitHub Issues for task management and feature tracking. Check out the Issues page to:

• Report bugs
• Request new features
• See planned improvements
• Contribute to development

Current priorities:

• Code quality improvements (linting, testing)
• CI/CD automation
• Accessibility support
• Enhanced animations and interactions

Screenshots