Sanyaoyi Kotlin

🌐 Languages: English Dcc | 中文文档

Project Introduction

Sanyaoyi Kotlin is a Kotlin-based divination software, similar to Mei Hua Yishu, aimed at providing users with an efficient and concise I Ching divination solution.

📖 Instructions

Sanyaoyi refers to the three changing lines of a hexagram.

⚊ Tian Yao (Heavenly Line)
⚊ Ren Yao (Human Line)
⚊ Di Yao (Earthly Line)

The eight trigrams are: ☰ (Qian), ☱ (Dui), ☲ (Li), ☳ (Zhen), ☴ (Xun), ☵ (Kan), ☶ (Gen), ☷ (Kun).

✨ Features

1. Modern Code Structure: Written in Kotlin, taking full advantage of its conciseness and safety.
2. High Performance: Optimized algorithms and data structures ensure efficient application performance.
3. Easy to Extend: Modular design, making it convenient to add and maintain future functionalities.
4. Excellent Documentation: Provides detailed user guides and API documentation to help developers get started quickly.
5. Sanyaoyi I Ching Divination: Implements a similar divination function to Mei Hua Yishu, allowing users to conveniently perform I Ching analysis.

😎 Tech Stack

• Kotlin: Primary programming language.
• Android SDK: For building Android applications.
• Gradle: Build tool, managing project dependencies.

💿 Installation and Usage

1. Clone the Project:

git clone https://github.com/afterow/sanyaoyi-kotlin.git
cd sanyaoyi-kotlin

2. Build the Project: Open the project in Android Studio, and Gradle will automatically download the required dependencies.

3. Run the App: Connect an Android device or start an emulator, then run the app from Android Studio.

🤝🏼 Contribution

Contributions of any form are welcome! Please follow these steps:

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Create a new Pull Request.

📜 License

This project is licensed under the MIT License. Please refer to the LICENSE file for more details.

📠 Contact

If you have any questions or suggestions, please contact us through GitHub Issues.

🛠️ Todo

• Add Heavenly Stems and Earthly Branches
• Add 64 Hexagrams
• Add Specified Divination
• Add Specified Changing Lines
• Add Counting Divination
• Add Save as Image or Share Function
• Add Time Divination
• Add the nine-square plate
• Optimize the homepage
• Add the function of random arrangement of the plate
• Add the function of random moving line