Skip to content

PATCH (Professional Automated Text Conversion Helper) is a web-based tool that uses AI to transform raw text into properly formatted screenplays, following Hollywood industry standards. Built with Next.js and powered by Ollama.

License

Notifications You must be signed in to change notification settings

midnightroachmedia/patchai

Repository files navigation

PATCH - Screenplay Formatting Assistant

PATCH is a web-based screenplay formatting tool that helps writers convert their raw text into properly formatted screenplays following Hollywood standards. This project is built with Next.js and bootstrapped with create-next-app.

Features

  • Real-time screenplay formatting
  • Live preview with proper formatting
  • Export to PDF
  • Customizable display options:
    • Multiple font types (Sans-serif, Serif, Monospace, etc.)
    • Adjustable font sizes (12px - 24px)
    • Bold text toggle
  • Character limit indicator (1,875 characters)
  • Re-roll functionality for alternative formatting

Technical Details

Core Components

  • Editor component with real-time formatting
  • PDF export functionality
  • Ollama API integration for script processing

API Configuration

  • Context window: 4096 tokens
  • GPU acceleration enabled
  • 8 thread processing
  • Temperature: 0.0 (focused output)
  • Top-k: 30
  • Top-p: 0.7
  • Repeat penalty: 0.8

Getting Started

  1. Clone the repository

  2. Install dependencies:

npm install
# or
yarn install
# or
pnpm install
# or
bun install
  1. Set up environment variables:
NEXT_PUBLIC_OLLAMA_BASE_URL=your_ollama_url
NEXT_PUBLIC_OLLAMA_MODEL=your_model_name
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
  1. Open http://localhost:3000 with your browser

Usage

  1. Enter your unformatted script in the left text box
  2. Click "Format" to convert your text
  3. Preview the formatted version in the right panel
  4. Adjust display settings using the top toolbar
  5. Export to PDF when satisfied with the formatting

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Technical Requirements

  • Node.js 16.x or higher
  • Next.js 14.x
  • Modern web browser with JavaScript enabled
  • Ollama API endpoint

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

© 2023 PATCH. All rights reserved.

Support

For support, please open an issue in the repository or contact the development team.

About

PATCH (Professional Automated Text Conversion Helper) is a web-based tool that uses AI to transform raw text into properly formatted screenplays, following Hollywood industry standards. Built with Next.js and powered by Ollama.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published