mirror of
https://github.com/Darkrock-Studios/hammer-editor.git
synced 2026-08-05 15:49:46 +00:00
124 lines
15 KiB
Markdown
124 lines
15 KiB
Markdown
# <img src="readme/logo.svg" alt="Hammer Logo" width="48" valign="middle"> Hammer: A story editor
|
|
|
|
A simple tool for building stories.
|
|
|
|
![badge-kotlin]  [](https://github.com/Darkrock-Studios/hammer-editor/actions/workflows/build.yml) [](https://app.codacy.com/gh/Darkrock-Studios/hammer-editor/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
|
[](https://codecov.io/gh/Darkrock-Studios/hammer-editor)
|
|
|
|
![badge-platform-android] ![badge-platform-ios] ![badge-platform-windows] ![badge-platform-linux] ![badge-platform-macos]
|
|
|
|
[](https://discord.gg/GTmgjZcupk)
|
|
[](https://crowdin.com/project/hammer-editor)
|
|
|
|
### Available on:
|
|
|
|
| Platform | App Store | Direct download |
|
|
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **Android** | [](https://play.google.com/store/apps/details?id=com.darkrockstudios.apps.hammer.android) [](https://f-droid.org/en/packages/com.darkrockstudios.apps.hammer.android/) | [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.apk) |
|
|
| **iOS** | [](https://apps.apple.com/us/app/hammer-editor/id6771650681) | — |
|
|
| **Windows** | [](https://apps.microsoft.com/detail/9p84lm8qv5x6) | [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.msi) [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.exe) |
|
|
| **macOS** | [](https://apps.apple.com/us/app/hammer-editor/id6770841038) | [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.dmg) |
|
|
| **Linux** | [](https://snapcraft.io/hammer-editor) | [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.deb) [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.rpm) [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.AppImage) [](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.flatpak) |
|
|
|
|
### Community
|
|
Join our [Discord](https://discord.gg/GTmgjZcupk) and help us by reporting bugs, making feature requests, and discussing
|
|
the future of Hammer.
|
|
|
|
Or visit us on Reddit at [r/hammereditor](https://www.reddit.com/r/hammereditor/)
|
|
|
|
Take a look at the [Roadmap](docs/ROADMAP.md) to see whats coming.
|
|
|
|
## Multi-platform
|
|
|
|
This app is where ever you are. Your phone, tablet, desktop, laptop, this program can be installed and run, not simply a
|
|
website-in-a-box, but instead using native client side technologies to provide the best experience possible.
|
|
|
|
## Multi-Screen
|
|
|
|
Whether you are on a phone, tablet, or desktop, Hammer will make the best use of your screen space.
|
|
Also supporting both light and dark modes.
|
|
|
|
|
|
|
|
## Offline first
|
|
|
|
I was frustrated with most of the story writing software I was finding as they were using web technologies (_aka: Web
|
|
Page in a box_) which always seems to run into problems while being used offline for long periods of time. Hammer is
|
|
designed from the ground up to be entirely local, no internet connection required, ever.
|
|
|
|
## Transparent Data
|
|
|
|
Your data is yours. It's not stored in the cloud, or some opaque database. It is stored in simple, human readable files,
|
|
just using files and folders to define the project structure. You can open your OSes file browser and take a look for
|
|
your self. If this program went away today you would be able to easily interact with your data.
|
|
|
|
## Intelligent Syncing between devices
|
|
|
|
Your data can be synchronized between devices allowing you to work on your story from anywhere, and have no fear of a
|
|
change on one device, overwriting a change on another device.
|
|
|
|
## Optional and Self hosted Syncing
|
|
|
|
Syncing is entirely optional, you can install the client and use it on one device, or you can
|
|
install the server and sync your data between devices. You could even use some other service to sync
|
|
your data, like
|
|
Dropbox, Google Drive or [syncthing](https://syncthing.net/). (_however these will only work for
|
|
syncing between desktop
|
|
computers. Mobile clients will have to use the built in syncing protocol._)
|
|
|
|
It's all up to you. Instructions can be found [here](docs/HOW-TO-RUN-A-SERVER.md).
|
|
|
|
If you don't know how, or just don't want to setup your own server, we're also running an official
|
|
syncing server.
|
|
|
|
### Official Server: [hammer.ink](https://hammer.ink/)
|
|
|
|
This is also the best way to support the project! Subscribe to our [Patreon](https://www.patreon.com/darkrockstudios) in
|
|
order to get instant access to this official Sync server.
|
|
|
|
This official server endeavors to be a reliable, and secure way to sync your projects. We perform regular backups, and
|
|
of course encrypt all of our data both in transit, and at rest in our database. Let us manage the server, and you worry
|
|
about writing!
|
|
|
|
#### Test Environment
|
|
|
|
~~We're also running a test environment here: [test.hammer.ink](https://test.hammer.ink/) which is always running the
|
|
latest commit.~~
|
|
|
|
~~_Do not use the test environment for real data! It will get cleared from time-to-time without notice!_~~
|
|
|
|
## 🪨 Dark Rock Studios
|
|
|
|
[**Dark Rock Studios**](https://darkrock.studio/) is all about building **Free and Open Source Software**.
|
|
|
|
🐛 Found bugs?
|
|
💡 Have suggestions?
|
|
📚 Want to help translate?
|
|
🎮 Interested in our other apps?
|
|
👉 Join our community of Open Source enthusiasts on [**Discord**](https://discord.gg/ju2RQa5x8W)!
|
|
|
|
# Development
|
|
|
|
Want to contribute? Great! [Here are some instructions to get you started](DEVELOPMENT.md).
|
|
|
|
## Having a problem?
|
|
|
|
Visit our [support](SUPPORT.md) page.
|
|
|
|
[](https://repology.org/project/hammer-editor/versions)
|
|
|
|
<!-- TAG_DEPENDENCIES -->
|
|
|
|
[badge-kotlin]: https://img.shields.io/badge/kotlin-blue.svg?logo=kotlin
|
|
|
|
<!-- PLATFORMS -->
|
|
|
|
[badge-platform-linux]: http://img.shields.io/badge/platform-linux-2D3F6C.svg?style=flat
|
|
|
|
[badge-platform-android]: http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat
|
|
|
|
[badge-platform-ios]: http://img.shields.io/badge/platform-ios-CDCDCD.svg?style=flat
|
|
|
|
[badge-platform-windows]: http://img.shields.io/badge/platform-windows-4D76CD.svg?style=flat
|
|
|
|
[badge-platform-macos]: http://img.shields.io/badge/platform-macos-111111.svg?style=flat
|