Expand description
This library contains methods for divination using the I Ching. The related CLI app was inspired by the original ching(6) unix program.
The I Ching (a.k.a. the Book of Changes) is an ancient method of divination based on cleromancy (assigning meaning to the generation of apparently random numbers.) Six numbers between 6 and 9 are generated in order to create a hexagram, the meaning of which is contained in the I Ching book.
You can find lots of great information on the 2000+ year history of the I Ching on Wikipedia
Installing and running the CLI app
To install the CLI app, just run
cargo install iching
Once installed, you can access the help screen by running the CLI with no arguments.
If you find any issues, please submit them through Github.
A simplified example of using this library:
use iching::{Hexagram, HexagramOrdering, HexagramRepository, divination_method::DivinationMethod};
// Implementing the HexagramRepository trait is the most complex
// aspect of using this library. See the included CLI app for an
// example implementation called HexagramExampleRepository.
let hexagrams: &mut dyn HexagramRepository<HexagramInfo = HexagramExampleInfo> = &mut HexagramExampleRepository::new();
// Don't forget to initialize repository after construction, else
// it could fail to work or even panic.
hexagrams.initialize().expect("Initialization of hexagrams has failed");
// Create a new random hexagram.
let new_hexagram = Hexagram::new_random(DivinationMethod::AncientYarrowStalk);
// Fetch the hexagram's info from the repository that was initialized earlier.
let hexagram_info = hexagrams.get_info_for_hexagram(&new_hexagram);
// Print the hexagram info for the user
print!("{hexagram_info:?}");Re-exports
pub use hexagram::Hexagram;pub use hexagram::HexagramOrdering;pub use hexagram_repository::HexagramRepository;Modules
Types related to the various methods of divination.
Hexagrams are used for divination in the I Ching.
This module contains hexagram generation and management tools.Contains traits for implementing generic repositories of hexagram meanings.
Lines are the building blocks of Hexagrams and Trigrams.
This module contains ways of randomly generating linesA collection of various I-Ching related symbols, in unicode or ASCII-art form.
Trigrams are the building blocks of Hexagrams.
This module contains trigram generation and management tools.