Skip to content

Commit

Permalink
feat(docs): Add jekill to fformat docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Estrada Irribarra, Rodrigo Andres committed Oct 14, 2024
1 parent 988c34e commit a894eca
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
30 changes: 15 additions & 15 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,22 @@ According to Sanderson, **strong outlines** provide the scaffolding for a story,
1. **Chapter-by-Chapter Synopsis**: This follows Sanderson's advice on **progressive complications**—setting up expectations and slowly building tension ([Sanderson's Second Law](https://www.brandonsanderson.com/sandersons-second-law/)).
```bash
storycraftr outline chapter_synopsis "Outline each chapter of a dystopian society where gods are purged from human memory." es
storycraftr outline chapter_synopsis "Outline each chapter of a dystopian society where gods are purged from human memory.
```
2. **Character Summary**: Strong characters are the core of a compelling story. This is consistent with Sanderson's approach to creating well-rounded characters and conflict ([Sanderson's First Law](https://www.brandonsanderson.com/sandersons-first-law/)).
```bash
storycraftr outline character_summary "Summarize the main characters of a story where humanity rebels against divine control." es
storycraftr outline character_summary "Summarize the main characters of a story where humanity rebels against divine control.
```
3. **General Outline**: A good general outline ensures that your story remains on course and your magic or technology systems are **consistent with the internal rules** ([Sanderson's First Law](https://www.brandonsanderson.com/sandersons-first-law/)).
```bash
storycraftr outline general_outline "Summarize the overall plot of a science fiction where gods no longer rule humanity." es
storycraftr outline general_outline "Summarize the overall plot of a science fiction where gods no longer rule humanity.
```
4. **Plot Points**: Identifying major plot points is crucial to creating meaningful **progression** and **revelation**, a principle Sanderson emphasizes in creating impactful stories ([Sanderson's Second Law](https://www.brandonsanderson.com/sandersons-second-law/)).
```bash
storycraftr outline plot_points "List the key plot points for a sci-fi rebellion against the gods." es
storycraftr outline plot_points "List the key plot points for a sci-fi rebellion against the gods.
```
## Step 4: Build Your World
Expand All @@ -64,27 +64,27 @@ Sanderson’s [Laws of Magic](https://www.brandonsanderson.com/sandersons-first-
1. **Culture**: Establishing the cultural background of the world brings depth and richness to the setting, following Sanderson's idea that **limitations are more interesting than powers** ([Sanderson's Second Law](https://www.brandonsanderson.com/sandersons-second-law/)).
```bash
storycraftr worldbuilding culture "Describe the culture of a futuristic world where religion and faith have been outlawed." es
storycraftr worldbuilding culture "Describe the culture of a futuristic world where religion and faith have been outlawed.
```

2. **Geography**: Geography plays a key role in worldbuilding, establishing settings that shape the characters and their journey, in line with Sanderson’s focus on **setting limitations** that challenge characters.
```bash
storycraftr worldbuilding geography "Describe the geography of a dystopian city controlled by technology after the fall of the gods." es
storycraftr worldbuilding geography "Describe the geography of a dystopian city controlled by technology after the fall of the gods.
```
3. **History**: Sanderson advises **creating internal consistency** in your world's history to enrich the present and future of your story.
```bash
storycraftr worldbuilding history "Outline the history leading to the rebellion against the gods." es
storycraftr worldbuilding history "Outline the history leading to the rebellion against the gods.
```
4. **Magic System**: This will follow Sanderson’s **First Law**: "An author's ability to solve conflict with magic is directly proportional to how well the reader understands the magic." Defining rules early is crucial.
```bash
storycraftr worldbuilding magic_system "Describe the technology that replaced divine powers in the society." es
storycraftr worldbuilding magic_system "Describe the technology that replaced divine powers in the society.
```
5. **Technology**: In line with Sanderson's advice on **restrictions**, the advanced technology in your world should have defined limits that drive the plot forward.
```bash
storycraftr worldbuilding technology "Describe the advanced technology that shapes everyday life in a post-divine world." es
storycraftr worldbuilding technology "Describe the advanced technology that shapes everyday life in a post-divine world.
```
## Step 5: Write Your Chapters
Expand All @@ -93,27 +93,27 @@ With a well-outlined story and a detailed world, we can now generate the chapter
1. **Generate the Cover**:
```bash
storycraftr chapters cover "Design a cover for a science fiction novel about the fall of the gods." es
storycraftr chapters cover "Design a cover for a science fiction novel about the fall of the gods.
```
2. **Generate the Back Cover**:
```bash
storycraftr chapters back_cover "Write a synopsis for the back cover of a sci-fi story where gods no longer exist." es
storycraftr chapters back_cover "Write a synopsis for the back cover of a sci-fi story where gods no longer exist.
```
3. **Generate Chapter 1**: Starting strong with **character conflict** and **tension** is key to grabbing the reader’s attention.
```bash
storycraftr chapters chapter "Write the first chapter where the rebellion against the gods begins." es 1
storycraftr chapters chapter "Write the first chapter where the rebellion against the gods begins. 1
```
4. **Continue writing additional chapters**: Follow Sanderson’s advice on **gradually increasing stakes** and building toward the climax.
```bash
storycraftr chapters chapter "Write the second chapter where the protagonist learns about the secret of the gods." es 2
storycraftr chapters chapter "Write the second chapter where the protagonist learns about the secret of the gods. 2
```
5. **Generate the Epilogue**: Wrap up with **meaningful resolution** to tie together the themes and the characters' journey ([Sanderson's Third Law](https://www.brandonsanderson.com/sandersons-third-law/)).
```bash
storycraftr chapters epilogue "Write the epilogue where humanity starts rebuilding after the fall of the gods." es
storycraftr chapters epilogue "Write the epilogue where humanity starts rebuilding after the fall of the gods.
```
## Step 6: Publish Your Book
Expand All @@ -136,7 +136,7 @@ If you initialized your book with alternate languages, you can translate the con
## Learn More About Writing
The ideas in this tool are heavily inspired by [Brandon Sanderson’s Laws of Magic and Writing](https://www.brandonsanderson.com/pages/writing-advice). StoryCraftr is designed to help you implement these concepts while crafting well-structured stories with strong character arcs and consistent plot development.
The ideas in this tool are heavily inspired by [Brandon Sanderson’s Laws of Magic and Writing](https://www.brandonsanderson.com/the-law-of-writing). StoryCraftr is designed to help you implement these concepts while crafting well-structured stories with strong character arcs and consistent plot development.
---
Expand Down
18 changes: 9 additions & 9 deletions docs/iterate.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,69 +15,69 @@ For example, if you've already generated a chapter synopsis and run the command
Over time, as you develop your story, you might want to check for consistency in character names. This command will **scan all chapters** for character names and either fix inconsistencies or make recommendations.

```bash
storycraftr iterate check-names "Check character names for consistency." es
storycraftr iterate check-names "Check character names for consistency."
```

To update or fix a character name across the entire book:

```bash
storycraftr iterate fix-name "Update character 'Santi' to 'Santiago' throughout the book." es
storycraftr iterate fix-name "Update character 'Santi' to 'Santiago' throughout the book."
```

### 2. Refine Character Motivation

Characters need strong motivations, and sometimes these evolve as you write. This command will **refine character motivations** throughout the book, ensuring consistency and depth.

```bash
storycraftr iterate refine-motivation "Refine the motivations of 'Elena' in a story about rebellion against gods." es
storycraftr iterate refine-motivation "Refine the motivations of 'Elena' in a story about rebellion against gods."
```

### 3. Strengthen Story Argument

The core argument or theme of your story can sometimes become diluted. This command will **reiterate and strengthen the argument or theme** across the book to ensure it is clear and compelling.

```bash
storycraftr iterate strengthen-argument "Ensure the argument of rebellion against divine control is clear." es
storycraftr iterate strengthen-argument "Ensure the argument of rebellion against divine control is clear."
```

### 4. Insert Chapters and Adjust Numbering

Sometimes, you may need to insert a chapter between two existing ones. This command will **insert a new chapter** and automatically **adjust the numbering** of all subsequent chapters.

```bash
storycraftr iterate insert-chapter "Insert a new chapter between chapters 3 and 4." es 3
storycraftr iterate insert-chapter "Insert a new chapter between chapters 3 and 4." 3
```

### 5. Split a Chapter

If a chapter becomes too long or covers too many topics, you can **split it into two separate chapters**. This command will split the specified chapter and adjust the numbering of all subsequent chapters.

```bash
storycraftr iterate split-chapter "Split chapter 5 into two chapters." es 5
storycraftr iterate split-chapter "Split chapter 5 into two chapters." 5
```

### 6. Add Flashbacks

Flashbacks are a great way to add depth to a character’s backstory. This command lets you **add a flashback scene** between two chapters, ensuring it integrates seamlessly with the surrounding narrative.

```bash
storycraftr iterate add-flashback "Add a flashback between chapters 6 and 7." es 6
storycraftr iterate add-flashback "Add a flashback between chapters 6 and 7." 6
```

### 7. Update Plot Points

Plot points are critical to maintaining tension and momentum in your story. Use this command to **update or refine key plot points** across the story, making sure they align with the latest developments in the book.

```bash
storycraftr iterate update-plot-points "Refine the plot points around the rebellion’s climax." es
storycraftr iterate update-plot-points "Refine the plot points around the rebellion’s climax."
```

### 8. Consistency Check Across All Files

Before completing your book, it's important to check for consistency across all files. This command will **review the entire structure** to ensure character arcs, motivations, plot points, and even worldbuilding elements are aligned.

```bash
storycraftr iterate check-consistency "Ensure consistency of character arcs and motivations throughout the story." es
storycraftr iterate check-consistency "Ensure consistency of character arcs and motivations throughout the story."
```

## Iterating Efficiently
Expand Down

0 comments on commit a894eca

Please sign in to comment.