79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
 
|
# Accordance API Status
|
||
|
|
|
||
|
|
## Current Situation
|
||
|
|
|
||
|
|
Based on the forum discussion (topic 37607), the Accordance API/OSC integration appears to be a **"user-driven vision"** rather than a fully implemented feature yet.
|
||
|
|
|
||
|
|
**There is no OSC option in Accordance Preferences** because the feature hasn't been released yet.
|
||
|
|
|
||
|
|
## What This Means
|
||
|
|
|
||
|
|
- ✅ **Your Bible App integration is ready** - The code is prepared to receive Accordance data
|
||
|
|
- ⏳ **Accordance API is not yet available** - The feature is still in development/planning
|
||
|
|
- 📝 **You're seeing test data** - The placeholder text is intentional until Accordance releases the API
|
||
|
|
|
||
|
|
## Options Going Forward
|
||
|
|
|
||
|
|
### Option 1: Wait for Accordance API Release
|
||
|
|
|
||
|
|
Keep an eye on:
|
||
|
|
- **Accordance Forums:** https://forums.accordancebible.com/
|
||
|
|
- **Forum Topic:** https://forums.accordancebible.com/topic/37607-accordance-api-a-user-driven-vision-for-the-future/
|
||
|
|
- **Accordance Updates:** Check for new versions that might include OSC/API support
|
||
|
|
|
||
|
|
### Option 2: Contact Accordance Support
|
||
|
|
|
||
|
|
Reach out to Accordance to:
|
||
|
|
- Express interest in the API feature
|
||
|
|
- Ask about timeline for release
|
||
|
|
- Request beta access if available
|
||
|
|
- Provide feedback on what you'd like to see
|
||
|
|
|
||
|
|
**Contact:** support@accordancebible.com
|
||
|
|
|
||
|
|
### Option 3: Use Current Test Data
|
||
|
|
|
||
|
|
The integration currently provides enhanced test data for common words:
|
||
|
|
- **love** - Full Strong's data (G25)
|
||
|
|
- **faith** - Full Strong's data (G4102)
|
||
|
|
- **god** - Full Strong's data (G2316)
|
||
|
|
- **christ** - Full Strong's data (G5547)
|
||
|
|
- **lord** - Full Strong's data (G2962)
|
||
|
|
|
||
|
|
For other words, you'll see a message explaining the situation.
|
||
|
|
|
||
|
|
### Option 4: Manual Integration
|
||
|
|
|
||
|
|
You could manually:
|
||
|
|
1. Use Accordance's **Instant Details** feature
|
||
|
|
2. Copy/paste definitions into your notes
|
||
|
|
3. Use Accordance's search features to look up words
|
||
|
|
|
||
|
|
## What Happens When Accordance Releases the API
|
||
|
|
|
||
|
|
Once Accordance implements OSC/API support:
|
||
|
|
|
||
|
|
1. **Enable it in Accordance Preferences** (when available)
|
||
|
|
2. **Update the port** in `osc-config.json` if needed
|
||
|
|
3. **Restart your Bible App server**
|
||
|
|
4. **It should work automatically!** - The integration is already coded and ready
|
||
|
|
|
||
|
|
## Current Integration Status
|
||
|
|
|
||
|
|
✅ **Server code:** Ready to send/receive OSC messages
|
||
|
|
✅ **Client code:** Ready to display Accordance data
|
||
|
|
✅ **Popup cards:** Ready to show Accordance information
|
||
|
|
⏳ **Accordance API:** Not yet available
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. **Continue using the app** - Test data will show for common words
|
||
|
|
2. **Monitor Accordance forums** - Watch for API announcements
|
||
|
|
3. **Contact Accordance** - Express interest in the feature
|
||
|
|
4. **Check Accordance updates** - New versions might include API support
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
The integration is **ready and waiting** for Accordance to release their API. Once they do, it should work automatically. Until then, you'll see helpful test data and messages explaining the situation.
|
||
|
|
|