Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosmo/clippy
📎💬🎉 Clippy from Microsoft Office is back and runs on macOS! Written in Swift.
https://github.com/cosmo/clippy
clippy hacktoberfest macos spritekit swift
Last synced: about 11 hours ago
JSON representation
📎💬🎉 Clippy from Microsoft Office is back and runs on macOS! Written in Swift.
- Host: GitHub
- URL: https://github.com/cosmo/clippy
- Owner: Cosmo
- Created: 2019-09-04T09:23:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-29T16:14:51.000Z (about 5 years ago)
- Last Synced: 2024-12-18T05:07:19.966Z (4 days ago)
- Topics: clippy, hacktoberfest, macos, spritekit, swift
- Language: Swift
- Homepage:
- Size: 9.07 MB
- Stars: 747
- Watchers: 19
- Forks: 31
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Clippy
Yes, Clippy from Microsoft Office is back — on macOS!
---
Clippy can be moved around (drag with mouse) and be animated (right-click).
The `SpriteKit`-Framework is used to animate through Clippy's sprite map.
---
## First start
1. [Download Clippy for macOS](https://github.com/Cosmo/Clippy/releases/download/2.0.0/Clippy.zip) or build from source.
2. Run
3. Click `📎` → `Show in Finder` in the menu bar
4. Unzip all files
5. Click `📎` → `Reload`
6. Pick an Agent under `📎` → `Agents` → `…`
## Todos
* [x] Animations (Right-Click → Animate! or press the Space bar)
* [x] Always on top
* [x] Sounds
* [x] Mute / Unmute
* [x] Transparent when out of focus
* [x] Support for other agents
* [x] Agent picker
* [x] Menu bar Item
* [ ] Original size / Zoom
* [ ] Actions
* [x] Hide
* [x] Show
* [ ] MoveTo x y
* [ ] GestureAt x y
* [x] Play animation
* [ ] Clean up
* [ ] Rewrite the ugly parts (many references and force unwraps)
* [ ] Extract the Agent reader into its own libary
* [ ] Test!
* [ ] HitTest on transparent regions
* [ ] Support branching and probability
* [ ] Idle animations
* [ ] Languages
* [ ] Control via command line
## Demo
## Build
```sh
git clone https://github.com/Cosmo/Clippy.git
```
* Open project with Xcode
* Build and run the macOS target
## Add other Agents (optional)
An `*.acs` file includes all required resources (bitmaps, sounds, definitions, etc.) of an agent.
Unfortunately, this project does not support `*.acs` files, yet. But hopefully in the future — pull-requests are welcome.
Until then, you can convert `*.acs` files with the "[MSAgent Decompiler](http://www.lebeausoftware.org/software/decompile.aspx)" by Lebeau Software.
This software extracts all resources that we need, from an `*.acs`.
There are a few steps involved.
### Requirements
```
brew install imagemagick
```
Will be used to merge single `*.bmp` sprites into a single 32 bit PNG-file.
```
brew install ffmpeg
```
Will be used to convert `*.wav`-files in RIFF format to MP3 files.
### Conversion
Included in this project is a converter called `agent-converter.sh`.
This tool takes opaque BMP sprites, removes background colors, puts them together to one big transparent PNG file and converts all sounds to MP3.
`./agent-convert.sh PATH_TO_AGENT NEW_NAME`
`AGENT_PATH` path to decompiled agent directory.
`NEW_NAME` should only include lowercase letters.
#### Example
`./agent-convert agents/CLIPPIT clippy`
### Final step
After the conversion step, you will get a new folder called `NEW_NAME.agent`.
1. Click `📎` → `Show in Finder` in the menu bar.
2. Move it to the Agents directory.
3. Click `📎` → `Reload`
4. Select new Agent under `📎` → `Agents` → `…`
## Attributions
Inspiration was taken from:
* https://github.com/tanathos/ClippyVS (C#)
* https://github.com/smore-inc/clippy.js (JavaScript)
Graphics were created by *Microsoft*.
## Clippy: The Unauthorized Biography
Watch the Unauthorized Biography with [Steven Sinofsky](https://twitter.com/stevesi), if you're interested in Clippy's history!
[](https://www.youtube.com/watch?v=8bhjNvSSuLM)
## Contact
* Devran "Cosmo" Uenal
* Twitter: [@maccosmo](http://twitter.com/maccosmo)