sanctum-ui
v1.0.2
Published
CSS Framework inspired by Elden Ring aesthetics
Maintainers
Readme
🗡️ SanctumUI Framework
A dark fantasy CSS framework inspired by the mystical world of Elden Ring
✨ Features
- 🌑 Dark Theme - Deep, immersive dark color palette
- ✨ Golden Accents - Magical golden highlights and glowing effects
- 🎭 Fantasy Typography - Cinzel font family for medieval aesthetics
- 🎪 Magical Animations - Flame effects, rune pulses, and glowing transitions
- 📱 Responsive Design - Mobile-first approach with flexible grid system
- 🎨 Customizable - Easy to extend with SASS variables and mixins
- ⚡ Lightweight - Minimal file size, maximum impact
🚀 Installation
Via npm
npm install sanctum-uiVia CDN
<link rel="stylesheet" href="https://unpkg.com/sanctum-ui/dist/sanctum-ui.min.css">Download
Download the latest release from GitHub Releases.
💫 Quick Start
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>My Elden Ring Site</title>
<link rel="stylesheet" href="path/to/sanctum-ui.min.css">
</head>
<body>
<div class="container">
<h1 class="flame-text">Welcome, Tarnished</h1>
<div class="card card-bordered">
<h3>Quest Log</h3>
<p>Begin your journey through the Lands Between...</p>
<button class="btn">Start Adventure</button>
</div>
</div>
</body>
</html>🎨 Components
Buttons
<button class="btn">Primary</button>
<button class="btn btn-secondary">Secondary</button>
<button class="btn btn-danger">Danger</button>
<button class="btn btn-large">Large Button</button>Cards
<div class="card">
<h4>Basic Card</h4>
<p>Card content goes here</p>
</div>
<div class="card card-bordered">
<h4>Golden Bordered Card</h4>
<p>Enhanced with magical golden border</p>
</div>Forms
<div class="form-group">
<label for="input">Mystical Input</label>
<input type="text" id="input" class="enchanted" placeholder="Enter magic...">
</div>Animations
<h1 class="flame-text">Flickering Text</h1>
<div class="rune-pulse">Pulsing Element</div>🛠️ Development
Prerequisites
- Node.js (v14 or higher)
- npm or yarn
Setup
# Clone the repository
git clone https://github.com/tosentai/sanctum-ui.git
cd sanctum-ui
# Install dependencies
npm install
# Start development
npm run dev
# Build for production
npm run buildFile Structure
sanctum-ui/
├── scss/ # SASS source files
├── dist/ # Compiled CSS
├── docs/ # Documentation and demo
└── assets/ # Additional resources🎭 Customization
SASS Variables
// Override default variables before importing
$er-gold: #your-gold-color;
$er-bg-primary: #your-background;
@import '~sanctum-ui/scss/styles';CSS Custom Properties
:root {
--er-gold: #custom-gold;
--er-bg-primary: #custom-background;
}📖 Documentation
Visit our documentation site for:
- Complete component gallery
- Customization guide
- SASS mixins reference
- Best practices
🤝 Contributing
- Fork the repository
- Create your feature branch (git checkout -b feature/amazing-feature)
- Commit your changes (git commit -m 'Add amazing feature')
- Push to the branch (git push origin feature/amazing-feature)
- Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- Inspired by Elden Ring’s incredible visual design
- Google Fonts for the Cinzel font family
- The Dark Souls community for endless inspiration
“May you find your worth in the waking world.”
⚡ Development Commands
# Install dependencies
npm install
# Development (watch mode)
npm run dev
# Build production CSS
npm run build
# Build minified version
npm run build-min
# Run all builds
npm run build && npm run build-min
# Publish to npm
npm publish